Skip to end of metadata
Go to start of metadata

Introduction

An API connection is a preconfigured connection that provides access to API activities to be used either as a source to provide data to an operation or as a target to consume data in an operation.

Accessing the Preconfigured API Connection

From the design canvas, open the Connectivity tab of the design component palette:

To access the preconfigured API connection, use the Show dropdown to filter on Endpoints to access the API connection block:

There is no user input required for setting up an API connection.

NOTE: As the connection is already ready to use, there is no API connector available to configure when the Show dropdown is filtered on Connectors.

Next Steps

Using the preconfigured API connection, you can configure one or more API activities associated with that connection to be used either as a source (to provide data within an operation) or as a target (to consume data within an operation).

Use the Show dropdown to filter on Endpoints, and then click the API connection block to display activities that are available to be used with an API connection:

For more information, see these activities:

  • API Request or Response: Configured using a JSON, XML, CSV, or XSD schema.
    • API Request: Receives data from an API endpoint and is intended to be used as a source in an operation.
    • API Response: Returns data to an API endpoint and is intended to be used as a target in an operation.
  • API SOAP Request or Response: Configured using a WSDL schema.
    • API SOAP Request: Receives data from an API endpoint and is intended to be used as a source in an operation.
    • API SOAP Response: Returns data to an API endpoint and is intended to be used as a target in an operation.
On This Page

Last updated:  Jan 21, 2021

  • No labels