This is a quickstart guide on pushing a resource or API from the Celigo platform integrator.io to the APIM console. The content is for API developers who want to create and publish APIs for internal or external consumption. If you want to use a published API, see API consumers.
You can push any resource (export, lookup, import, Javascript API, or webhook listener) or API from the Celigo platform integrator.io to the APIM console. Below is a basic diagram of configuring your API in integrator.io.
Note
-
We recommend that you clone your resource using Actions (...) and add a note to your resource title (ex. “DO NOT MODIFY – Used in APIM”). This helps you track which resources are used in APIM and prevents users from changing an existing resource that uses APIM.
-
Before pushing to the APIM console, ensure the connections are online. The push will fail if you don’t have a working connection.
-
In most cases, the Celigo platform will automatically create an OpenAPI specification; however, you must update and publish your API documentation in the APIM console before it's fully available.
Warning
You'll receive errors if you try to push an API with any of the following:
-
Navigate to → → .
-
Find your API in the list and click → .
-
A new pane will appear so you can configure your API.
-
Click Create a new API in manager or Add to existing API in manager.
-
Gateway URL (dynamic, non-editable field): a preview of the Gateway URL. It’s a combination of the
<Base URI>+<Gateway context path>+<Endpoint>. It will adjust dynamically based on the other fields. -
Context path (required): Unique identifier for the API in your manager. This field must be unique if you’re creating a new API since it will hold all endpoints related to the API. For example, if you’re creating a connection to SpaceX, your Gateway context path would be
/spacex. -
Operation (required): This dropdown field allows you to choose which operation you want to perform. For exports, the
GEToperation is automatically generated. There are several operations, but Celigo's APIM supports:-
GET -
POST -
PUT -
DELETE
-
-
Endpoint (required when adding to an existing API): Enter an endpoint. This describes the specific endpoint you’re retrieving. For example, if your API is
/spacexand your export calls a list of all rockets, your endpoint would be:rockets. This will appear under Design → Flows in the APIM console. -
Click Push to APIM.
-
Navigate to Resources and select your resource type.
-
Find your resource, click Actions (...) →Push to APIM.
-
A new pane will appear so you can configure your API.
-
Click Create a new API in manager or Add to existing API in manager.
-
Gateway URL (dynamic, non-editable field): a preview of the Gateway URL. It’s a combination of the
<Base URI>+<Gateway context path>+<Endpoint>. It will adjust dynamically based on the other fields. -
Context path (required): Unique identifier for the API in your manager. This field must be unique if you’re creating a new API since it will hold all endpoints related to the API. For example, if you’re creating a connection to SpaceX, your Gateway context path would be
/spacex. -
Operation (required): This dropdown field allows you to choose which operation you want to perform. For exports, the
GEToperation is automatically generated. There are several operations, but Celigo's APIM supports:-
GET -
POST -
PUT -
DELETE
-
-
Endpoint (required when adding to an existing API): Enter an endpoint. This describes the specific endpoint you’re retrieving. For example, if your API is
/spacexand your export calls a list of all rockets, your endpoint would be:rockets. This will appear under Design → Flows in the APIM console. -
Click Push to APIM.