All Products
Document Center

Manage an API

Last Updated: Dec 01, 2017
API definitions refer to the definitions related to the API request structure when you create an API. You can view, edit, delete, create, or copy an API definition on the console. Pay attention to the following points when you are working with API definitions:
  1. Editing the definition of a released API does not affect the definition in the production environment unless you release and synchronize it to the production environment.
  2. It is not allowed to directly delete the API definition. Deprecate the API definition before deleting it.
  3. You can copy the definition from the test/production environment to overwrite the latest definition, and then, if needed, click Edit to modify the definition.

API release management

You can release or deprecate an API in a test or production environment with the following attentions:

  1. You can access the second-level domain name or independent domain name to call the API that is released to the test or production environment.
  2. The latest released version of an API overwrites the preceding version in the test/production environment and takes effect in real time.
  3. When you deprecate an API in the test/production environment, the binding policy, keys, app, and authorization persists are automatically deprecated unless the API is released to production again. To revoke this relationship, you must delete it.

API authorization management

You can establish or revoke the authorization relationship between an API and an app. API Gateway verifies the permission relationship. During authorization, pay attention to the following points:

  1. You can authorize one or more APIs to one or more apps. We recommend that you do not operate APIs in multiple groups at the same time during batch operation.
  2. During batch operation, select an API and related environment. For example, if an API has been released to both the test and production environments, but only the test environment is chosen, only the API in the test environment is authorized.
  3. You can locate an app based on the AppID or Alibaba Mail account provided by the customer.
  4. When you need to revoke the authorization for an app under an API, you can view the API authorization list and delete the app from the list.

Release history and version switching

You can view the release history of each of you APIs, including the version number, notes, test/production, and time of each release.

When viewing the release history, you can select a version and switch to it. The new version directly overwrites the previous one and takes effect in real time.