Enable Apigee Integration add-on

To enable the integrations feature in Apigee, you can either create an evaluation (eval) org for trials or pay for the integrations if you have an Apigee subscription.

Enable integrations in an eval org

An eval org lets you try out the Apigee integrations feature without getting billed for the usage. To understand how to provision an eval org, see Provision an eval org.

Use an eval org if your objective is only to explore and play with the integration feature, as the integrations created in an eval org have some limitations.

For more information, see Comparing eval and paid organizations.

The eval org will already have the integrations and the connectors add-on enabled. The connectors add-on is required to access external data sources from your integrations. So after provisioning the eval org, you only have to enable the following APIs for the eval org, and you are good to use the integrations feature.

  • Application Integration API (integrations.googleapis.com)
  • Connectors API (connectors.googleapis.com)

For information on how to enable the APIs, see Enabling services.

Enable integrations in a paid org

If you want to use Apigee integrations without any limitations, you can pay for the integrations. Apigee Integration is available as an add-on service for your subscription.

If you have already purchased the Apigee Integration entitlement, and want to enable the entitlement to your Google Cloud project or Apigee organization, contact Apigee support. However, if you want to purchase the Apigee Integration entitlement, contact Apigee sales. After Apigee Integration has been enabled for you, perform the following tasks:

  1. Enable the following APIs:
    • Apigee API (apigee.googleapis.com)
    • Application Integration API (integrations.googleapis.com)
    • Secret Manager API (secretmanager.googleapis.com)
    • Connectors API (connectors.googleapis.com)

    For information on how to enable the APIs, see Enabling services.

  2. Enable the Integration and the Connectors add-ons for your Apigee organization.

    • If you are creating a new organization to use for Integration, run the following command:

      curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" -d '{"name":"${ORG_ID}", "analyticsRegion":"us-west1", "authorized_network":"${NETWORK_ID}", "runtimeType":"CLOUD", "runtimeDatabaseEncryptionKeyName":"${ENCRYPTION_KEY_NAME}", "addonsConfig": {"integrationConfig": {"enabled": true}, "connectorsPlatformConfig":{"enabled":true}}}' "https://apigee.googleapis.com/v1/organizations?parent=projects/${PROJECT_ID}"

    • If you are using an existing organization, run the following command:

      curl -H "Authorization: Bearer $TOKEN" -H "content-type:application/json" "https://apigee.googleapis.com/v1/organizations/${ORG_ID}:setAddons" -XPOST -d '{"addonsConfig":{"integrationConfig":{"enabled":true},"connectorsPlatformConfig":{"enabled":true}}}'
  3. Verify if the add-ons are successfully enabled using the following command:

    curl -H "Authorization: Bearer $TOKEN"  -H "content-type:application/json" "https://apigee.googleapis.com/v1/organizations/${ORG_ID}"

    Running the command, should display a message similar to the following:

    {
"name": "Test....",
"createdAt": "1615483867669",
"lastModifiedAt": "1615483873468",
…...
"addonsConfig": {
  "integrationConfig": {
    "enabled": true,
  "connectorsPlatformConfig": {
    "enabled": true
  }
}
}
  4. Assign the following IAM roles to your default Apigee service account(service-PROJECT_NUMBER@gcp-sa-apigee.iam.gserviceaccount.com):
    • Apigee Integration Invoker (roles/integrations.apigeeIntegrationInvokerRole)

    For information about granting additional roles or permissions to a service account, see Granting, changing, and revoking access.

What's next