Subscribing API in Developer Portal
This article will guide you as a developer on how to log in to the developer portal, apply for API subscriptions to obtain access credentials, and successfully call the API.
Prerequisites
Search for API
Access the open platform and navigate to the desired API by utilizing categories, API names, and descriptions. Additionally, thoroughly review the OpenAPI Spec documentation to ensure a comprehensive understanding of how to utilize the API effectively.
Create Application
When applying for API subscriptions, it is done based on applications.
The API keys are not specific to individual developers, but are categorized according to business applications. If multiple applications within the same organization need to call the same API, they must utilize distinct access credentials. For instance, if both Department A and Department B require access to the same external API, it is necessary for the API administrator to differentiate between the sources of these calls. This distinction allows for future allocation of call quotas based on departments. As such, Department A and Department B should each create separate applications responsible for managing and maintaining the respective API keys within their own departments.
Alternatively, if there are two distinct systems within Department A that need to access the same external API, separate applications should be established to differentiate between the calling sources and impose additional restrictions on call frequency based on each system.
Apply for API Subscription
Select the target application, initiate an API subscription request, and wait for approval from the API administrator.
Approval by the Administrator
How to approve API subscriptions.
Find API Key in the Application
Once the subscription request is approved by the administrator, find the corresponding API subscription record in the application details, view the access credentials, and call the API according to the usage instructions in the API documentation. For the same application, if multiple APIs with the same authentication method (e.g., key-auth) are subscribed, the corresponding access credentials will be the same.
Withdraw API Subscription Request
During the approval waiting period, you can withdraw the request. You can initiate a new request later.
Rejection of API Subscription Request
If the request is rejected, you can initiate a new request.