Calling APIs

Obtaining APIs and Documentation

Before calling APIs, obtain the request information from the API provider, including the access domain name, protocol, method, path, and request parameters.

Obtain APIs: from your company or from a partner

Obtain related documentation from the help center of the API provider's official website:

The authentication information to be obtained varies with the API authentication mode.

App authentication:
- Signature authentication: Obtain the key and secret (or client AppKey and AppSecret) of the app authorized for the API from the API provider as well as the SDK for calling the API.
- Simple authentication: Obtain the AppCode of the app authorized for the API from the API provider.
- Other authentication modes: Obtain the key and secret (or client AppKey and AppSecret) of the app authorized for the API from the API provider.
IAM authentication: The account credential (token or AK/SK obtained with the account and password) obtained on the cloud service platform is used for authentication. If the AK/SK is used for authentication, you also need to obtain the SDK from the API provider for calling the API.
Custom authentication: Obtain the custom authentication information to be carried in the request parameters from the API provider.
None: No authentication information is required.

Calling an API

Set the request path.

Scenario	Request Parameter Configuration
Calling an API with a domain name	Call the API using the subdomain name allocated to the API group or a domain name bound to the group. No additional configuration is required.

Set the authentication parameters.

Authentication Mode	Request Parameter Configuration
App authentication (with a signature)	Use the SDK to sign API requests. For details, see section "Calling APIs Through App Authentication" in the Developer Guide.
App authentication (through simple authentication)	Add the header parameter X-Apig-AppCode and set the parameter value to the AppCode obtained in Obtaining APIs and Documentation.
IAM authentication (with a token)	Obtain a token from the cloud platform and carry the token in API requests for authentication. For details, see section "Token Authentication" in the Developer Guide.
IAM authentication (with AK/SK)	Use an SDK to sign API requests. For details, see section "AK/SK Authentication" in the Developer Guide.
Custom authentication	Carry authentication information in API request parameters for authentication.
None	Call APIs without authentication.