Skip to Content

API connection

Introduction

An API connection is a preconfigured connection of the API connector that provides access to API activities to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation). The operation is then referenced during custom API configuration in API Manager.

For information on the relationship between API connector activities and API Manager APIs, see these resources:

Next steps

Since the API connection is already pre-configured, place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.

These activity types are available:

  • Request: Configured using a JSON, XML, CSV, or XSD schema, this activity retrieves data when called by an API Manager custom API and is intended to be used as source to provide data to an operation.

  • Response: Configured using a JSON, XML, CSV, or XSD schema, this activity returns data to an API Manager custom API and is intended to be used as a target to consume data in an operation.

  • SOAP Request: Configured using a WSDL schema, this activity retrieves data when called by an API Manager custom API and is intended to be used as source to provide data to an operation.

  • SOAP Response: Configured using a WSDL schema, this activity returns data to an API Manager custom API and is intended to be used as a target to consume data in an operation.