Articles in this section

Push and publish your resource or API

Kathyana Queeman
Updated

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 resources and APIs from integrator.io to the APIM console. 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 must enable the Skip aggregation setting if you're pushing resources or APIs to API Management using any of the following import applications. This requirement does not apply to blob imports.

Push an API

To push an API created in API builder:

Warning

You'll receive errors if you try to push an API with any of the following:

  • Disabled API in API builder

  • Un-configured API request or response

  • Disabled connections

  1. Navigate to Resources → APIs → API builder.

  2. Find your API in the list and click Actions (...) → Push to APIM.

    Push_to_APIM_in_actions_menu.png

  3. A new pane will appear so you can configure your API.

    Push_to_APIM__full_API_.png

  4. Click Create a new API or Add to existing API.

  5. API definition: The default API definition version is v4, but you can choose v2 for backward compatibility and in cases where your APIM policy isn't supported in v4.

    An API definition is a JSON representation of all the information the API management console and gateway need to know to proxy requests, apply policies, and create plans for your APIs and their transactions.

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

  7. Context path (required): Unique identifier for the API in your manager. This field must be unique when creating a new API, since it will hold all endpoints for the API. For example, if you’re creating a connection to NASA, your Gateway context path would be /nasa.

  8. HTTP method (required): This dropdown field allows you to choose which operation you want to perform. For exports, the GET operation is automatically generated. There are several operations, but Celigo's APIM supports:

    1. GET 

    2. POST 

    3. PUT 

    4. DELETE 

  9. 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 /nasa and your export calls a list of all rockets, your endpoint would be: rockets. This will appear under APIs+Policy Studio → Design → Flows in the APIM console.

  10. Click Push to APIM.

Push a resource

You can push any export, lookup, import, or webhook listener.

  1. Navigate to Resources and select your resource type.

  2. Find your resource, click Actions (...) →Push to APIM.

    Push_to_APIM_in_actions_menu.png

  3. A new pane will appear so you can configure your API.

    Push_to_APIM__full_API_.png

  4. Click Create a new API or Add to existing API.

  5. API definition: The default API definition version is v4, but you can choose v2 for backward compatibility and in cases where your APIM policy isn't supported in v4.

    An API definition is a JSON representation of all the information the API management console and gateway need to know to proxy requests, apply policies, and create plans for your APIs and their transactions.

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

  7. Context path (required): Unique identifier for the API in your manager. This field must be unique when creating a new API, since it will hold all endpoints for the API. For example, if you’re creating a connection to NASA, your Gateway context path would be /nasa.

  8. HTTP Method (required): This dropdown field allows you to choose which operation you want to perform. For exports, the GET operation is automatically generated. There are several operations, but Celigo's APIM supports:

    1. GET 

    2. POST 

    3. PUT 

    4. DELETE 

  9. 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 /nasa and your export calls a list of all rockets, your endpoint would be: rockets. This will appear under APIs+Policy Studio → Design → Flows in the APIM console.

  10. Click Push to APIM.