Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents
maxLevel2
absoluteUrltrue

Overview

You can create applications and subscribe to APIs in the Developer Portal.

New subscriptions must be approved by an Org admin in the Applications tab of the Subscription Manager. Learn how: Managing Applications in Subscription Manager

Create an Application

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

    Image RemovedThe Application page showing the Create New Application cardImage Added

  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.

    Image Removed
    Click Create and Continue if The Create Application pageImage Added

  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 and exit the Create Application dialog. 

Create Subscription

  1. In the Create Subscription dialog, use the API Search field

    , enter the API names

    to find an API you want to subscribe to and click the API card to

    . Select

    select it.
    After selecting all the APIs

    and

    you want, click Continue.
    NOTE: You can subscribe only to APIs that allow subscription.

    Image RemovedThe Select API tab of the Create Subscription pageImage Added

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

    Image RemovedThe Subscription tab of the Create Subscription pageImage Added

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

    Image RemovedThe Register tab of the Create Subscription pageImage Added

  4. On the

    application

    Applications page, applications with

    API subscriptions that are

    pending or approved API subscriptions have a key icon, in addition to the edit

    or

    and delete icons.Image Removed

    Clicking on an application with the key icon will Application cards, one of which shows the key iconImage Added

  5. To show the status of the subscription

    . Subscriptions can have a status of

    , click on the application card. The status can be Active, Revoked, or Pending.Image Removed

How to Use a Subscribed API

Users logged in to a Developer Portal for an Org can create applications. These applications have an associated client id and a client secret. The user can subscribe an application to any API on the portal that allows subscriptions. 

How to Use Your Application Secret to Use an API

Once your application is a approved for subscription to an API, you can use the application's client secret to execute the API via the Authorization header at type token. For example:

Authorization: token <client secret>

The application client secret acts as your API Key to access an approved API.

  1. Image Added

Anchor
edit-app
edit-app
Edit an Application

  1. Click

    In the Developer Portal, go to the Applications page, click the edit icon to edit your application.

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

    Click Save when you are done.
    Image Removed


    Edit Application dialogImage Added

  3. You can also manage your Client Secret.

    • Click the copy icon ((blue star)) under Client Secret to copy it to your clipboard. Your subscription must already be approved.

    • Click Refresh Secret to increase the expiration date of your secret key by a year.

    • Click Regenerate Secret to generate a new secret key and refresh the expiration.

      Generating a new

      Regenerating the secret key updates the secret key of all subscriptions associated with this application. The new secret key will automatically be saved

      regardless of

      whether you click Save or not.

  4. Click Save.

Access 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 to copy the Client Secret to your clipboard.

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

    Code Block
    Authorization: token <client secret>

    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.

Delete an Application

Click the delete icon to remove an application and all its API subscriptions. Click Confirm to delete the application. Image Removed

...