Prerequisites for integration

You're viewing Apigee Edge documentation.
Go to the Apigee X documentation. info

This page outlines that must be completed before you can enable the Apigee Edge API hub connector integration.

Step 1: API hub provisioning

To provision API hub within your Google Cloud project:

  1. Create a Google Cloud project:
    • Navigate to the Google Cloud Console.
    • From the project selector, click New Project.
    • Enter a project name and select a Billing account.
    • Click Create.
    • Alternatively, use the gcloud CLI: 
      gcloud projects create PROJECT_NAME
  2. Enable the API hub APIs and provision API hub:
    • In the Google Cloud console, search for "Apigee API hub."
    • Navigate to the API hub service.
    • Click Enable APIs if prompted.
    • Follow the on-screen provisioning flow to set up API hub. During this process, ensure you enable any required entitlements and add-ons for processing both metadata and runtime events.

Step 2: Plugin instance creation

A plugin instance in API hub acts as a registration point for one or more Apigee Edge Organizations.

  • Navigate to the API hub console.
  • Follow the steps in Create a custom plugin to create a new plugin instance.
  • During this process, you will obtain an Instance Resource Name (also referred to as Gateway ID). This ID uniquely identifies your Apigee Edge Organization within API hub and is crucial for the next step.

Apigee Edge API hub connector integration setup (Opt-in for an Organization)

Once the plugin instance is successfully created in API hub, you need to configure your Apigee Edge organization to send data to it. This step requires orgadmin permissions within the respective Apigee Edge organization for all the API calls required for the API hub connector integration setup.

To enable the API hub connector integration for an Apigee Edge organization, use the following command:

curl -X POST https://api.enterprise.apigee.com/v1/organizations/ORG_NAME uapim/settings \
  -H "Authorization: Bearer OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "gatewayId": "INSTANCE_RESOURCE_NAME"
  }'

Where:

  • ORG_NAME is the name of your Apigee Edge organization.
  • OAUTH_TOKENis the OAuth token used to authenticate the request. For more information on creating an OAuth token, see Get the tokens.
  • INSTANCE_RESOURCE_NAME: The Instance Resource Name (Gateway ID) obtained from the previous step.

Upon successful execution, your Apigee Edge organization is registeredwith the specified API hub plugin instance, initiating the synchronization process for both API metadata and runtime data.