In this article

Overview

To use an API in the Developer Portal, you must:

  1. Create an entry for your application. The application entry holds the Client ID and Client Secret that the server needs to identify your application as an approved consumer of the APIs.

  2. Subscribe to the APIs you need to call.

  3. Wait for your subscription to be approved. New subscriptions are approved by an Org admin in the Applications tab of the Subscription Manager.

  4. Call the APIs using the Bearer authorization scheme with the Client Secret.

note

Check the API Key expiration date when you encounter a 401 error. Renew the API key to resolve the error encountered.

Check the API Key expiration date when you encounter a 401 error. Renew the API key to resolve the error encountered.

Create an Application Entry

  1. In the Developer Portal, go to the Applications page, and click Create New Application.                                                                              

  2. In the Create Application dialog, enter the Application Name, and select Web or Mobile in the Type field. You can also add a description.

  3. If you want to subscribe to an API, click Create and Continue. This will open the Create Subscription dialog.
    If not, click Create and Exit to create your application entry and exit the Create Application dialog. 

Subscribe to an API

  1. In the Create Subscription dialog, use the API Search field to find an API you want to subscribe to and click the API card to select it.
    After selecting all the APIs you want, click Continue.
    NOTE: You can subscribe only to APIs that allow subscription.

  2. In the Subscription tab, you can add an optional comment to your selected APIs. Click Continue.

  3. In the Register tab, you will see a summary page of your application entry and the APIs you selected.
    Click Register to submit your application entry and subscription request.

  4. On the Applications page, application entries with pending or approved API subscriptions have a key icon ((blue star)) in addition to the edit icon ((blue star)) and delete icon ( (blue star) ).
    TIP: Click (blue star) to copy the Client Secret to your clipboard quickly.

  5. To show the status of the subscription, click on the application entry card. The status can be Active, Revoked, or Pending.

Edit an Application Entry

  1. In the Developer Portal, go to the Applications page, then point and click the target Application card.

  2. You can change the Application Name, Type, or Description.

  3. You can also manage your Client Secret.

    1. Click (blue star) under Client ID and Client Secret to copy it to your clipboard. Your subscription must already be approved.

    2. Click Refresh Secret to extend the expiration date of your secret key by a year.

    3. Click Regenerate Secret to generate a new secret key and refresh the expiration. Regenerating the secret key updates the secret key of all subscriptions associated with this application entry. The new secret key will automatically be saved whether you click Save or not.

  4. You can also subscribe to more APIs within your Application.

    1. Click the Subscriptions tab.

    2. Click Add Subscriptions.

    3. Click See All to browse through the APIs.

    4. Point and click the target API cards. When you scroll to the bottom of the page, you can see your selected APIs.

    5. Click Continue.

    6. Proceed through the Subscription wizard and click Register.

Call the API Using Your Application’s Client Secret

After your API subscription is approved, you can use your application's client secret as your API Key to access an approved API.

  1. Edit your application entry or click the key icon ((blue star)) on your application’s card to copy the Client Secret to your clipboard.

  2. When you configure your application to send a request, add the following Authorization request header:

  3. Replace <client secret> with the value stored in your clipboard.
    IMPORTANT: This must be the only Authorization request header in your application.

Learn more about the Authorization request header.

If the API or Proxy is published with custom subscription key parameters (as a header or query parameter), you can also pass your Client Secret using those parameters. Learn how to specify custom subscription key parameters when publishing an API version or Proxy.

Delete an Application Entry

Click the delete icon ( (blue star) ) to remove an application entry and all its API subscriptions. Click Confirm.