API Products

The API Products screen displays the products available to be used in applications.

Subscription status will be "no" if products are not used by any application. To subscribe to a product, register an application.

API Catalog

Click the product name to see the API categories (groups under which various APIs are available) available in the selected product.

Registering an application

To register an app,

  1. Click the Applications tab and click the Register button.



  2. Select the products required for the app and provide name and details that represent the function of the application and click Register.

    Provide the URI to redirect to a particular page after authorization.



  3. The app gets registered with the ID provided.

    An acknowledgment message appearing on the top of the page.

    • Click Edit to make any changes to the application.
    • Click Unregister to unsubscribe the products.

Fetching Consumer Key and Customer Secret

Click the Application Id name (see the figure above) to see the Consumer Key and Consumer Secret generated for the respective product.

Checking API Documentation

Click the Product Id name (see the figure above) or click the API Products tab to go to the API Products page.

Notice that the Subscription status is changed to "yes" as the products are subscribed by the application.

Click the API Product name (see the figure above) to see the API Categories in the product; click the environment name of the respective API category to work with the APIs associated with the project.

Authorization

Detailed documentation of the API with complete information about the parameters involved, sample requests and responses, and authentication mechanisms used can be viewed in the API Documentation section.

If the REST APIs are protected, click the Authorize button to unlock the APIs.

Provide the Client ID which is the Consumer Key mentioned in the Subscribing and Accessing APIs section of the respective product and click Authorize.

An error message gets displayed for invalid input.


Testing the APIs

Expand a tag to see the APIs available under it.

Expand the API to see the parameters under it and click the Try it out button to test the API.

Forums

Forum section helps to start a discussion or take part in a discussion. For any questions or suggestions to the administrator, post them in the Forums section as a new Topic.

Users will be able to interact using the forum only after the administrator approves the user to post in the forum.

To post content in the forum,

  1. Click the Forum name (see the figure above) to create a topic.



  2. Provide the following and click Save.

    1. topic heading in the Subject text box.

    2. content in the Body text area.

      Before publishing the content, the Preview button helps to have a preview of the content as it appears on the forum.