Get server-side information
Before you connect a client to the gateway, you must obtain the following information from the API Gateway console:
Application information
API information
Application information
Application ID (APPID)
The APPID is the unique identity of an application within a specific environment in the gateway. You must set the APPID of the calling application in the client to establish a connection.
Procedure:
In the API Gateway console, go to the API Subscription > Application Management page.
Find the target application in the list and view its APPID.
Application key
Clients that subscribe to an API must be authenticated to access the gateway. Authentication uses an AccessKey and SecretKey pair.
Procedure:
In the API Gateway console, go to the API Subscription > Application Management page.
In the application list, find and click the name of the target application to open its product page.
Switch to the Key Configuration tab to view and copy the AccessKey and SecretKey.
API information
API endpoint
The API endpoint is the access address of an API on the gateway. The system automatically generates an endpoint when the API is created. All APIs in the same API group share one endpoint. The domain name format is {id}.antfinapigw.{env}.alipay.com. In this format, {id} is the API group ID and {env} is the environment context.
Procedure:
In the API Gateway console, go to the API Publishing > API Management page.
In the API list, find and click the target API to open its product page.
In the Basic Information section, view and copy the Endpoint.
API system cluster key
Applications from API publishers must be authenticated to connect to the gateway. Authentication uses an AccessKey and SecretKey pair.
Procedure:
In the API Gateway console, go to the API Publishing > System Cluster page.
In the list, find and click the target system cluster to open its details page.
Switch to the Authentication Configuration tab to view and copy the system cluster's AccessKey and SecretKey.
API request path, interface name, and method
Applications send requests to an API's request path to invoke the API.
Procedure:
In the API Gateway console, go to the API Subscription > Application Management page.
In the application list, find and click the name of the target application to open its product page.
In the API Subscription List, find the target API to obtain its request path, interface name, and method.