Managing API Clients and Access Policies

API owners can manage and monitor clients' usage of their APIs from the API Platform page.

The API Platform tool is accessible from the Tools menu. Once in the main API Platform page, select the Clients tab to create and manage API clients. A typical screen would look like this:

Create API Client Create API Client

A client must have a name, and may have a description and an associated logo or image.

Note that there is actually no requirement that an API client be a human individual. A client is associated with an API key, which grants access to a certain group of APIs, under the control of certain policies. The actual API caller might be a script or automated program, rather than a person. However, as a best practice, it is recommended that you distribute one API token per person you permit to access your API, so that you can identify the users who are making calls to your API endpoints.

Once a client is created in the Client tab, the API owner will then be prompted to create a new access profile for that client.

New Access Profile New Access Profile

The access profile screen has the following fields:

Field name Description
Name
(Required)
Provide a meaningful access profile name.
API collections
(Required)
One or more API collections to which the client has access.
Policy The policy that applies to this client.
IP Whitelist One or more IP addresses to be whitelisted. When this is set, only requests initiated from these addresses will be allowed: all other access will be denied.
Authentication method
(Required)
This can be an Auth Token or a JSON Web Token (JWT).

If "JSON Web Token (JWT)" is selected there are two additional fields available: signing method, and secret or key. See Access Tokens for details.

Once the access profile fields have been filled in, click on Add profile to create the client and save that client's associated profile. After this step, the screen will look something like this:

API client creation API client creation

Note the API Key field. A unique API key is generated for each client. This key is a long string of characters. It needs to be supplied to the client so that the client can connect to the API. Treat this API key as confidential information: it should be known only to the API owner and the client.

An API key can be revoked, and a new one issued, by clicking on the Refresh button next to the key.

A client can be Disabled or Enabled. A disabled client cannot call any APIs. Moving the slider right will switch the client's status to Enabled, after which he/she will be allowed to make API calls.

results matching ""

    No results matching ""