How to connect to Apigee with a Service Account Key File

There are several authentication options when connecting to Apigee. Use this option when you want the simplest setup and are comfortable managing a downloaded service-account key file. This option works from any deployment location.

Prerequisites

• Obtain GoogleKey Filename

  1. Log into Google Cloud console.

  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. Select ADD KEY → Create new key.

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

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

  

• Obtain Apigee Developer name 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.

  

Connect to Apigee

1. In API Control Plane, select Environments > Register Gateway.
2. Select Apigee API Management.

3. Add the following:

   • Gateway Name
   • Organization
   • Authentication Method : Service account key file
   • Service Account key file
   • Developer

4. Select Next.

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

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

2. Run the following command:

   docker compose up --pull always --detach

• The agent starts and connects automatically.

Check the Agent's Status

1. In API Control Plane, select Environments. Your agent is now connected to API Control Plane.

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