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 use as a source or target within an operation.

Accessing the Preconfigured API Connection

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

The preconfigured API connection is always available within the Endpoints filter:

There is no user input required for setting up an API connection. As the connection is already ready to use, there is no API connector available to configure within the Connectors filter.

Next Steps

Using the preconfigured API connection, you can then set up one or more API activities to use as a source or target within an operation:

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

Last updated:  Aug 06, 2019

  • No labels