Skip to main content
Feedback

How to connect to Apigee

On this page you will learn how to connect your Apigee Gateway to Boomi´s API Control Plane.

Prerequisites

To proceed, you will need the following:

  • A running instance of Boomi's API Control Plane.

  • Access to the instance of your Apigee Gateway.

  • Docker to utilize the image of our agent, which acts as an intermediary.

Create a new Environment

To get started, open your API Control Plane instance and follow the instructions below.

Add an Environment

  1. Navigate to Environments in the menu on the left side.

  2. Select the Register Environment button in the top right corner.

  3. Select Apigee API Management.

  4. Select Next.

Choose Platform Type

Add Environment Information

  1. Refer to Environment Settings for details about the options in the Environment Wizard.

How to - Environment Wizard - Add env information

  1. Select Register Environment.
  2. Select Next to start the Connection Wizard.

Provide the Gateway Information

The following section describes how to create the gateway configuration for a Apigee Gateway Agent.

Gateway Configuration

How to Apigee - Connection Wizard - Add Platform info

  1. Add the following:

    • Organization: Your Apigee Organization is shown in the top left after logging in to Apigee

      How to Apigee - Organization

    • GoogleKey Filename: To obtain a key file:

      1. Log into http://console.cloud.google.com/

      2. Go to IAM & Admin → Service Accounts.

      3. If necessary, create a new service account. Then click Manage Keys in the Actions menu for your service account.

      4. Click ADD KEY → Create new key.

      5. Choose JSON Format and save the generated key file.

    • Developer: This is the username of a developer that you have created in Apigee (under Publish → Developers). All Apigee Apps created by Boomi API Control Plane will use this Developer.

    How to Apigee - Developers

  2. Select Next.

  3. Select Download and Next. Your configuration file will download automatically.

Create an Agent as Intermediary

The following describes how to create a Docker container for the agent. It is described using a Docker compose file so that additional agents can be easily added to your docker stack later.

How to - Connection Wizard - Docker file

  1. Docker Compose file options:
    • image The docker image of the API Control Plane Agent
    • container_name You can change the name of your Agent here
    • environment
      • backendUrl The agent will establish a web-socket to this URL and connect to your API Control Plane.
      • agentToken
      • gateway.type
      • gateway.organization
      • gateway.googleKeyFile
      • gateway.developer
      • gateway.gatewayEnvironments=test-env,prod-env List of environments
    • volumes

How to - Connection Wizard - Docker commands

  1. Run the following command:

    docker compose up --pull always --detach

  • The agent starts and connects automatically.

Check the Agent's Status

  1. Go to your API Control Plane instance.

  2. Select Environments in the menu on the left side.

    • Your Agent should now be connected to API Control Plane

  3. Click on the tile or the entry in the table to get more detailed information about the status of the connection. This can be very useful in case of an error.

You can now interact with your Gateways through Boomi's API Control Plane.

tip

It is easy to add more agents Repeat the steps here or that of another gateway and add the agents to the existing Docker compose file.

On this Page