Subscribe to an API
Subscribing to an API product grants your application access to the APIs included in that product. This guide walks you through the subscription process.
Prerequisites
- A Developer Portal account with an active status. See Register and Log In.
- At least one application created.
Subscribe to an API Product
- Log in to the Developer Portal.
- Navigate to the API Hub.
- Click on the API product you want to subscribe to.
- Click Subscribe (or Subscribe Now).
- Select the application you want to subscribe with from the dropdown.
- Click Confirm.
Subscription Approval
After submitting a subscription request, one of two things happens:
Auto-Approved
If the API product has automatic subscription approval enabled, the subscription is immediately active. You can proceed to create credentials and start making API calls.
Pending Approval
If the API product requires manual approval:
- Your subscription enters a Waiting for Approval state.
- The API provider's administrators are notified of your request.
- You will be notified when the subscription is approved or rejected.
- Once approved, the subscription becomes active and you can create credentials.
You can check the status of your subscriptions in the application detail page under My Applications.
Subscribe to Multiple Products
You can subscribe a single application to multiple API products. Each subscription is independent:
- Different products may have different approval requirements.
- Credentials created in the application can be used with any of its subscribed products (as long as the credential type matches the product's authentication type).
You can also subscribe multiple applications to the same API product.
Cancel a Subscription
If you no longer need access to an API product:
- Navigate to My Applications and select the application.
- Find the subscription you want to cancel.
- Click Cancel and confirm.
Cancelling a subscription removes your access to the API product through this application. Existing credentials remain in the application but will no longer authenticate requests to the cancelled product's APIs.
Next Steps
After your subscription is active:
- Manage credentials to create authentication tokens.
- Try the API to test API calls directly from the Developer Portal.