Create Composite Endpoints

Edit online

You can define composite endpoints to call multiple APIs in sequence, passing the output of one API as the input to the next.

About this task

After a composite endpoint is defined, it can be called from a Design Server map, or flow like any other endpoint, but the action of calling it will make multiple API calls, one to each of the APIs defined in the sequence.
Example use cases for composite endpoints include:
  • Call a logon API to get an authorization token, and use that token in a subsequent call.
  • Call an API to look up the identifier of a particular record, and then perform some operation on that record.

Follow these steps to create a composite endpoint.

Procedure

  1. Go to a pre-existing Service or create a new Service and click on Create Composite Endpoint.
  2. Fill in the following fields in General Information.
    1. Enter the name of the endpoint under Name.
    2. Type the description of the endpoint in Description.
    3. Select or type a tag to group related endpoints.
    4. If the Connection Test Endpoint toggle is enabled, the endpoint will be called to test the connection to the server when the service is deployed as a connector.
    5. Click on Next, for the Endpoint List.
    6. Select the endpoints in the drop-down list and click on Validate to check if it is Successful or if any Issues were found.
    7. Click on Save to save the composite endpoint.