Integration API routes

Itential Platform automatically creates integration API routes for all paths listed in an integration model. This allows you to use Itential Platform as a gateway for the routes defined in the OpenAPI (OAPI) document.

Route example

When Itential Platform creates a route for an integration, it uses the name of the integration service and the operationId from the OAPI document. Using a GitHub OAPI document as an example, consider the following path object (response definitions removed for brevity):

1
"/emojis": {
2
  "get": {
3
    "summary": "Emojis_GET",
4
    "description": "Lists all the emojis available to use on GitHub.",
5
    "operationId": "Emojis_GET",
6
    "parameters": [
7
      {
8
        "name": "Accept",
9
        "in": "header",
10
        "description": "Is used to set specified media type.",
11
        "style": "simple",
12
        "schema": {
13
          "type": "string"
14
        }
15
      }
16
    ],
17
    "deprecated": false
18
  }
19
}

Itential Platform creates a route based on the integration name and the operationId. If you name the integration MyGitHub,Itential Platform creates the following route for /emojis:

http://<IAP base path>/MyGitHub/Emojis_GET

Reference

You can view the routes created by Itential Platform on the Help Desk page under Adapter/Integration API. Navigate to the menu icon on the left, select Help, then click the View Documentation button under Adapter/Integration API.

http://<IAP base path>/help

You can view detailed information about the OAPI document under the Integration Models section of Admin Essentials.

Click the name of the integration model and Itential Platform will render all the information contained in the OAPI document in the right panel.

Other uses

Exposed integration routes can also be used in JSON Forms validation in the same manner as application routes. Find your base URL and API route in the dropdowns.