Red Hat 3Scale API gateway

Capabilities

The ApiShare Connector for RedHat 3scale enables seamless integration between ApiShare and the third-party API gateway, ensuring automated synchronization and governance across multiple instances. The connector is triggered by user actions within ApiShare, particularly in the Subscription Management and Key Set Management functionalities. For each supported feature, refer to the corresponding sections of the documentation for further details.

API Subscription Management

Subscription Activation

Once a subscription request is approved in ApiShare, the connector automatically provisions the subscription on 3scale, enabling the consuming application to access the API.

During the first subscription of an application to a public API, the following entities are created and managed in 3scale:

• Account (Organization)

  • This account is traceable in ApiShare through the organizationMappings correlation document.

• Application Plan

  • An Application Plan is defined for the API subscription, establishing the consumption policies.

  • This entity is stored in ApiShare via the applicationMappings correlation document.

• Application

  • The application is registered in 3scale and linked to the selected Application Plan.

  • The application ID (application_id) is generated and stored in ApiShare.

The authentication key (apiKeyor app_id/app_key) is generated for the first subscription and remains unique for all future API subscriptions of the same application. This key is reused for subsequent API subscriptions, optimizing security and key management

Each of these entities is automatically provisioned and synchronized between ApiShare and 3scale, ensuring full governance of the API subscription lifecycle.

Subscription Suspension

Enables the temporary deactivation of an application's subscription to a single API on 3scale, restricting access while maintaining the subscription record. The API remains linked to the application, but its access is disabled.

The affected entity on 3scale is the Application. The Application it is suspended , not deleted. It remains present and can be reactivated later.

The subscription’s state is changed to suspended.

The enabled flag of the 3scale application is set to false, preventing API calls using the suspended subscription’s key.

Subscription Reactivation

Previously suspended subscriptions can be restored, granting the application access to the API again without requiring a new subscription request.

The 3scale application entity is resumed and the ApiShare subscription is updated in active state.

→ See Subscription Management.

Multi-Instance Management

The connector supports configurations with one or more 3scale instances, ensuring they remain continuously synchronized. A dedicated microservice retrieves specific work tasks from ApiShare, proactively managing configurations across instances. To guarantee operational reliability, agents operate based on a master-worker pattern.