Overview

Updated at:
Copy as MD

API Gateway is a platform for managing API services. It lets you publish your business services as APIs and grant access to external partners. Partner systems can then invoke these APIs. When an API is invoked, API Gateway forwards the request to the backend service to complete the service invocation. This topic helps you get started with API Gateway.

Roles

API Gateway involves the following two roles:

  • API publisher: Publishes service interfaces from their applications as APIs on API Gateway.

  • API subscriber: Uses a client to call authorized APIs published on API Gateway.

Workflow

The complete workflow for API Gateway is as follows:

Workflow

As shown in the preceding graph, to publish and call APIs through API Gateway, the API publisher and subscriber perform the following operations:

API publisher:

API subscriber:

  • Create a subscriber application: Create an API subscriber application in the console. Provide the application's APPID to the API publisher to obtain authorization.

  • Obtain server-side information: Obtain the configuration information for the application and API service from the console. This information includes the application's keys (AK/SK), the API service's domain name, the URI of the request, and the method.

  • Develop the subscriber application: Develop the subscriber application's client to call APIs.