Prerequisites for integration

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

These prerequisites such as setting up API Hub, creating a plugin instance, and configuring your Apigee Edge organization to connect with API Hub.

Step 1: API Hub provisioning

To begin, provision API Hub within your Google Cloud project.

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
```
Enable API Hub APIs and provision API Hub:
- In the Google Cloud Console, search for "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.

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 instructions 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.

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 setup.
To enable API hub connector for an Apigee Edge organization, make a POST request to the Edge management API:
```
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"
    }'
  
```
For OAuth, enter the following in the Key field: Bearer your-token (For more information, see Get the tokens).
- Key location: header
- Parameter name: Authorization
- Available authentication options:Basic and OAuth
Upon successful execution, this command registers your Apigee Edge organization with the specified API Hub plugin instance, initiating the synchronization process for both API metadata and runtime data.