Administration Interface

Once the Content API is installed and Services 3.x has been configured, you can now manage your API via the Content API Administration interface.

Administration Interface

Navigate to Administration -> Site Configuration -> Content API Settings

There are several tabs across the top, one for each content type (See the CCK Fields section below). The main page contains general settings.

Settings

Node Fields
API users will have access to all checked fields. If a field is unchecked, that node will not appear for users. For example, if the administrator unchecks “created,” users will not be able to see the node’s created date in the API.

Node Return Limit
Use this field to cap users from returning too many results and bogging down your server. Each node result requires a node_load() call, so setting the return limit to roughly 20 is appropriate for small servers depending on usage.

Default Sort Field
This can be any value in the node table.

Default Sort Order
Ascending or descending sort order.

Show count item as first result
By default, the first item returned is a count of all items that meet the query. An example:

<item> 
  <count>318</count> 
  <pages>31</pages> 
  <itemsPerPage>10</itemsPerPage> 
  <currentPage>0</currentPage> 
</item>

Uncheck this box to skip returning this count result.

Node types to publish in API
Select the types of nodes you want to give your api users access to

CCK Fields

On the /admin/settings/contentapi page, there is a list of all the node types listed as tabs. Clicking a tab will bring up a form listing all of the CCK fields associated with that node type.

By default, the API gives users access to all CCK fields. To avoid a field showing in the API, uncheck the corresponding node type by the CCK field you wish to remove.