Capabilities

The ApiShare Connector for Boomi API Gateway enables seamless integration between ApiShare and Boomi API Management, ensuring automation and governance across API lifecycle, subscription management, application lifecycle, and organization synchronization. This connector supports multiple features designed to enhance API governance and streamline API operations.

Each feature described below is triggered when the corresponding functionality is executed within ApiShare. For additional details on the Subscription Lifecycle, KeySet Management, API Lifecycle, Application Lifecycle, and Organization Synchronization, refer to the relevant sections of this documentation.

API Lifecycle Management

The Boomi API Gateway Connector facilitates API lifecycle operations by synchronizing ApiShare API states with Boomi API Management.

API Publishing & Promotion
When an API reaches the "Ready for Publishing" state in ApiShare, the connector creates or updates the corresponding service in Boomi API Gateway.

• Endpoint and method definitions are aligned with the API specification.

• Authentication configurations are applied.

• Plans are updated accordingly.

API Republishing & Updating
Any changes made to the API’s endpoints are reflected on Boomi API Gateway, ensuring consistency.

• Deprecated endpoints are removed.

• New endpoints are added.

API Retirement
When an API is retired in ApiShare, the connector:

• Removes all related services from Boomi API Gateway.

• Retains Package, Plans, and API Keys (emptying endpoint associations).

• Revokes any active API subscriptions.

→ See API Lifecycle

API Subscription Management

The connector automates API subscription operations, ensuring consistency between ApiShare and Boomi API Gateway.

Activating a Subscription

When activating a subscription in ApiShare, the connector ensures that:

• If missing for the target environment, a Package, Plan, Application, and Key are created on Boomi API Gateway.

• The API Service endpoints for the target environment are associated with the plan.

Retrieving Subscription Keys

Users can retrieve authentication credentials related to their subscriptions:

• ApiShare contacts Boomi API Gateway to fetch the API Key or App ID for the subscribed API.

• The retrieved key is displayed to the user within ApiShare.

Suspending or Revoking a Subscription

When a subscription is suspended or revoked:

• The API’s endpoints are removed from the assigned plan in Boomi API Gateway.

• If a subscription is later reactivated, the endpoints will be re-added automatically.

Notes

• The Application, Key, Package, and Plan on Boomi API Gateway will be reused for all subscriptions of the same Application within the same target environment.

• By default, all subscriptions of an application for a certain environment will share the QPS (Quota Per Second). However, this can be manually overridden within the Boomi API Gateway configuration on a case-by-case basis.

→ See Subscription Management

Application Lifecycle Management

The connector integrates with ApiShare's application lifecycle, ensuring Boomi API Gateway accurately reflects the current status of each application.

• Application activation

  • No emmediated changes occur in Boomi API Gateway. Application provisioning happens only when an API subscription is actived

• Application Retirement (with active subscriptions)

  • All subscriptions associated with the application are removed from ApiShare.

  • Corresponding plans, API keys, and package definitions are deleted from Boomi API Gateway.

• Application Retirement (without active subscriptions)

  • The application is deactivated in ApiShare, but no changes are made on Boomi API Gateway.

• Application Suspension

  • All active subscriptions remain in ApiShare, but API keys on Boomi API Gateway are disabled until reactivation.

→ See Application Lifecycle

Key Set Lifecycle Management

The connector supports automated authentication key operations, ensuring secure API access management.

Revoke KeySet
Deletes all applications using a specific keyset from Boomi API Gateway.

Automatic Rotation KeySet
Performs an automated rotation of authentication keys for all applications utilizing a given keyset.

Regenerate KeySet
Deletes all applications using a specific keyset and recreates them with newly generated authentication credentials.

Reactivate KeySet
Restores a previously suspended keyset, automatically reactivating all associated applications.

Suspend KeySet
Temporarily disables all applications using the specified keyset on Boomi API Gateway.

→ See KeySet management

Considerations on upgrading to ApiShare 1.9

When upgrading ApiShare with an active integration with Boomi API Management, the following will occur:

When one Application subscribes to more APIs with different Authentication Types, in the same Environment:

• version 1.8 shall have generated on Mashery the same Package Key for all those Subscriptions in the same Environment.

• upgrading to version 1.9 will produce different KeySets (for each different Authentication Type), but on Mashery the Package Key will remain the same.

• this will generate a many-to-one relationships between ApiShare’s Keysets and the Gateway’s Package Keys.

• this can be an ISSUE when revoking/rotating a KeySet, because it will revoke/rotate the same Package Key tied to other KeySets, but the other KeySets on ApiShare will never display the change, and this information would be lost.

Organization Synchronization

To ensure seamless integration, organizations within ApiShare can be paired and synchronized with those in Boomi API Gateway.

• Organization Pairing

  • Multiple ApiShare Organizations can be linked to the same Boomi API Gateway Organization.

  • At least one organization must be paired.

• Organization Synchronization (Optional)

  • Disabled by default: Organizations are manually mapped.

  • Enabled: New organizations created in ApiShare are automatically reflected in Boomi API Gateway.

→ See Organization Management

Multi-instance Management

The connector supports the configuration and synchronization of multiple Boomi API Gateway instances. A dedicated microservice ensures proper alignment by retrieving work tasks from ApiShare and executing them reliably. To enhance fault tolerance, connector agents operate based on a master-worker model.

API gateway object modeling

Considerations on Importing Subscriptions to ApiShare 1.9

When importing Subscriptions from Boomi API Management, different Applications-PackageKeys-Plans-Packages must exist for the same logical Application (as intended in ApiShare) if that Application is consuming APIs with different Authentication Types.