API

Add API

Publish a new API to the developer portal, so that developers can view API introduction and documentation, and subscribe to the API.

• The API must be associated with a route that already exists in the API7 Gateway and the required plugins on the route have been configured.
• A new API requires preparation of the OpenAPI Spec document in advance.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Developer Portal.
3. In the left menu bar, click on API .
4. Click on Add API button.
5. Fill in the form.
6. Click on Submit button.

Delete API

Delete an API when it is offline or deprecated.

• After the API is deleted, developers who previously subscribed to this API will immediately be unable to continue calling it. Be sure to ensure there is no business impact before proceeding.
• A deleted API cannot be recovered and must be re-added, and developers need to resubscribe.
• Deleting an API from the developer portal only means that subscriptions generated from the developer portal are no longer valid, and new subscriptions cannot be generated through the developer portal. This does not delete the associated route/API from the API7 gateway or affect the API keys you have distributed to developers through other means.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Developer Portal.
3. In the left menu bar, click on API .
4. Select the target API and click on the corresponding Delete button.

Add API Subscription by API Provider

The API provider can directly subscribe to the API for the application in the management console, eliminating the approval process. It can also be used for the initial caller of preset APIs.

• The application must be created by the developer first.
• The API cannot be directly subscribed or used by specific developers.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Developer Portal.
3. In the left menu bar, click on API .
4. Select the API to be subscribed to and click on the corresponding View button.
5. Click on Add API Subscription button.
6. Select the application to be subscribed to.
7. Click on OK button.

Cancel API Subscription by API Provider

The API provider can cancel the subscription of an API for a specific application in the management console, and the credential of the application for that API will become invalid.

• You can only cancel API subscriptions that have been successfully generated from the developer portal. If the related consumer or plugin has been manually modified on the API7 Gateway, it cannot be reflected in the developer portal.

1. Log in to the API7 Enterprise dashboard.
2. In the left menu bar, click on API .
3. Select the API subscription to be canceled and click on the corresponding View button.
4. Select the application to be canceled and click on the corresponding Cancel Subscription button.

Approve API Subscription Request

Developers can submit a subscription request for a certain API on behalf of an application. API providers approve the subscription request and the application obtains an API key (if authentication is enabled for the API).

• If the API itself does not have authentication plugins enabled and does not require an API key for invocation, then approving the API subscription request does not affect the ability to call the API directly.
• Active notification to the administrator for pending approval will be added in the future.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Developer Portal.
3. In the left menu bar, click on API .
4. Select the API to be approved for subscription and click on the corresponding View button.
5. Select the application to be approved for subscription and click on the corresponding Approve button.

Reject API Subscription Request

Developers can submit a subscription request for a certain API on behalf of an application. API providers reject the subscription request and the application is unable to call the API.

• If the API itself does not have authentication plugins enabled and does not require an API key for invocation, then rejecting the API subscription request does not affect the ability to call the API directly.
• Active notification to the API providers for pending approval will be added in the future.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Developer Portal.
3. In the left menu bar, click on API .
4. Select the API to be rejected for subscription and click on the corresponding View button.
5. Select the application to be rejected for subscription and click on the corresponding Reject button.