Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this page, you will find a step-by-step guide on how to connect your AWS API Gateway to APIIDABoomi's API Control Plane.

Prerequisites

To proceed, you will need the following:

...

Excerpt
nameCreate a new Environment

Create a new Environment

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

Add an Environment

  • Navigate to “Environments” in the menu on the left side

  • Click on the “Create New Environment” button in the top right corner

  • Choose your provider by clicking on it

  • Confirm by clicking on the "Next" button

image-20240209-154731.png

Add Environment Information

  • Complete the form below following the example below:

  • Confirm by clicking on the "Register Environment" button

  • Click Next here to start the Connection Wizard.

(tick) You’ve completed the first step!

...

You have two options to grant your agent access to your AWS API Gateway, depending on wheter whether you plan to host the agent inside AWS itself or elsewhere.

...

Excerpt
nameCheck the Agent's Status

Check the Agent's Status

  • Head over to your API Control Plane instance

  • Select “Environments” in the menu on the left side

    • Your Agent should now be connected to API Control Plane

EnvList4-20240209-155401.pngImage Removed

apiida.pngImage Added

Admin Portal

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

 

(tick) You’ve completed the last step!

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

Try it right now and discover your APIs!


💡 Tip: It is easy to add more agents!

Repeat this guide or that of another gateway and simply add the agents to the existing Docker compose file.

...