Contents

Popular

Clients can access your APIs after you add them under Client section and then add a Client Subscription to them, thereby binding with a single API consumer key which allows them to access the subscribed API products.

Icon

Refer Adding Products, Clients and Client Subscriptions section for a step by step instruction.

Click the Add  button to open the New Client dialog box.  In the Client ID field, provide a name for the client so that the API can identify the client internally.


Figure 1: Option to add a client with a client ID

Now provide the following details under the Configuration tab and click Save button to apply the changes.


Figure 2: Client Configuration attributes

AttributeDescription
Client IDThe name that you add while creating the client gets auto-populated.
Client NameProvide a name by which you can identify the client.
EmailEmail address of the client, which is used for all further communications including passing the secured keys.
Status

Provide the status of the client from the options as below, as per requirement:

  • Active: Activates the services for the client.
  • Inactive: Services will not be available for the client.
AttributesIn case there is a requirement to add additional attributes, click the Add  button corresponding to Attributes section and then add the attribute and the corresponding value.

Click Save button to add a client  with the above details (clicking Cancel at this point discards the changes)..

Icon
  • After saving the client, if you want to edit the properties of the client, just make the respective changes in the configuration panel and then click Save again.
  • To remove a client altogether, select the product under the Clients tab in the left navigation panel and click Remove button.
Icon

Developers registered through the developer portal will be available in this section.

Adaptavist ThemeBuilder EngineAtlassian Confluence