This quickstart guide helps API publishers configure an API after pushing it to the APIM console. For information on using a published API, see Socialize your API.
The APIM console will open in a new tab after you push your API or resource or open the console from the Tools menu in the Celigo platform. It won’t time out simultaneously to the Celigo platform, so you can keep the window open without signing in again.
Below is a basic diagram that outlines how to configure your API in the APIM console.
After pushing your API or resource, the APIM console will automatically populate several sections and fields.
Name: The name you gave your resource or API in the Celigo platform.
Description: The description of the resource or API you provided in the Celigo platform.
Version: Defaults to version 1.0.0.
Invoke URL: This allows users to invoke the API via a unique URL. It’s available in the Celigo platform in the Advanced section of your resource or the Actions (...) menu of your API in API builder. In the APIM console, it’s available at API → Backend services → Endpoint.
Each endpoint is automatically configured with an API key plan.
Policies are added to flows to enforce security, reliability, and proper data transfer. Examples of policies include traffic shaping, authentication/authorization, rate limiting, and dynamic routing. There are dozens of policies available. Three auto-populated policies will help your API’s performance. To learn more about the available policies, see the APIM Policy Reference Guide.
Three policies are automatically added to your API:
-
Override HTTP Method policy (available for resources only; not an API created in API builder): You can use the override-http-method policy to override the HTTP method provided by the initial consumer with a newly configured value when the inbound request is sent to the backend API. This policy does not act on messages and only applies to the request phase of API flows.
-
Transform headers policy: The Authorization is automatically set to Bearer API token. You can override the HTTP headers by:
-
Adding to or updating the list of headers
-
Removing headers individually
-
Defining a whitelist
-
-
Dynamic routing: The dynamic routing policy dispatches inbound calls to different targets and endpoints or rewrites URIs. This policy is particularly useful for creating API mashups.
Your gateway timeout settings determine how long your API consumers will wait before a timeout response is sent. The Connect timeout, Read timeout, and Idle timeout are automatically set to 5,000, 10,000, and 60,000 milliseconds, respectively. To configure your timeout:
You can manage your API policies in the Policy Studio, a no-code tool for creating and managing your API. You can configure policies to determine how consumers will interact with the API, including what features of the API they can access and what governance policy configurations are enforced. For more on the concept of a policy, see Learn more about API management feature. For a comprehensive list of all the available policies, see the APIM Policy Reference Guide.
Important
-
An APIM flow relates to the different phases of creating, managing, publishing, and subscribing to an API in APIM. This is not the same as a Celigo integrator.io flow.
-
You do not have to create a flow to add a policy to the API. However, adding a flow allows you to control better what phases a policy is added to.
Design your flow and add policies in the Design tab.
The Configure tab has two flow modes: default and best match. If you keep the flow mode as default, each flow's execution is determined independently based on the operator defined in the flow itself. Default mode allows for the execution of multiple flows. However, if you select Best match, the gateway will choose a single flow with the closest match to the path of the API request. A plain text part of the path will take precedence over a path parameter.
The Debug tab allows you to debug your flows by running the API.
Note
Creating a flow is optional because a flow is automatically created when you push a resource to the APIM console. Three auto-populated policies will help your API’s security and performance.
Before adding policies, you can configure a flow using the Create a new flow module. The ALL /** flow is a catch-all flow that applies the settings to every endpoint in your API. Learn more about API flows.
-
Click + in the left-hand side of the Policy Studio or click + Design new one to create a new flow.
-
Flow name: Give your flow a descriptive name. If you don't, a name will be automatically generated using the channel and operation.
-
Operator: Apply this flow to requests with a path that Equals or Starts with the specified Channel.
-
Channel: Define the path to use with the Operator to determine if this flow should be applied.
-
Entrypoints: Select the entrypoint(s) for which you want the flow to be executed. If none are selected, the flow will be executed for all possible entrypoints, assuming the conditions are met. Available entrypoints are
HTTP GET,HTTP POST, Websocket, Server-Sent Events, and Webhook. -
Entrypoints supported operations: Select Publish and/or Subscribe as the operation(s) supported by the entrypoint(s). If none are selected, both will be supported.
-
Condition: Define specific conditions that trigger flow execution using Expression Language (EL).
-
Click Create to add a flow.
-
Click Save in the upper right-hand side of the Policy Studio.
To add a policy to a flow:
Drag and drop the desired policies into the Request / Response interface. You can sort your policies by request or response on the right-hand side of the interface. You can also filter by or search for a specific policy.
You should configure and publish your API documentation before publishing your API.
After you’ve created your API and configured it as needed, click Start the API at API → Info → Danger Zone.
Click Deploy your API in the top banner. This doesn’t automatically publish your API to the Developer Portal but ensures the latest updates you’ve made are available. After you publish the API below, it will be deployed and updated in the Developer Portal with your latest changes.
You must publish your API to make it available in the Developer Portal. If you don’t publish your API, your customers cannot create an application or subscribe to your plans. To publish your API, navigate to the API → Danger zone → click Publish. You must individually configure and publish your OpenAPI specifications.
Finally, you should provide your APIM Developer Portal link to your API consumers. To access your link, navigate to Your account at the top right-hand side of the screen. Then, navigate to API settings → API management.
After publishing your API, you can configure more settings, including: