Skip to end of metadata
Go to start of metadata

Overview

Within API Manager, you can create and publish three types of APIs: 

Each type of API interacts with Jitterbit Harmony uniquely within the system architecture as described below. 

For more information on Jitterbit security and system architecture, see Jitterbit Security and Architecture White Paper.

Custom API

Custom APIs expose a Harmony operation for consumption. An operation must first be created and deployed to Harmony and can be any Cloud Studio or Design Studio operation. The existing operation is then referenced during the configuration of the Custom API and is called and consumed by an API consumer. Custom APIs are routed through Harmony Agents (either Cloud Agent Groups or Private Agents).

This diagram displays how a Custom API behaves in the system architecture when deployed with a Cloud Agent and a Cloud API Gateway:

  1. An API consumer makes a call to the Custom API located at the Cloud API Gateway
  2. The Custom API request is routed through the Cloud API Gateway to the messaging service, which routes requests for Agent Groups.

  3. A Cloud Agent receives the request from the messaging service. 
  4. The Cloud Agent references the Custom API operation specified during the Custom API configuration and triggers the deployed operation.
  5. The operation responds with an API payload consistent with the response type selected during the Custom API configuration.
  6. The API payload is routed from the Cloud Agent back to the API consumer.

    NOTE: Unless the operation being triggered by the API call is using temporary storage, the API payload will remain on the agent for only two days.

  7. Runtime status information and logs of running operations are sent to the transaction logs database.

    NOTE: Consumer data is not stored in the transaction logs database unless debug mode is enabled during Custom API configuration.

For information on configuring a Custom API, see Custom API Configuration.

OData Service

OData Services expose a Design Studio API entity operation for consumption. The API entity operation must first be created and deployed to Harmony. The existing API entity operation is then referenced during the configuration of the OData Service and is called and consumed by an API consumerOData Services are routed through Harmony Agents (either Cloud Agent Groups or Private Agents). 

This diagram displays how an OData Service behaves in the system architecture when deployed on-premises with a Private Agent and a Private API Gateway:

  1. An API consumer makes a call to the OData Service located at the Private API Gateway.
  2. The OData Service request is routed through the Private API Gateway. 
  3. The request is received by the messaging service, which routes requests for Agent Groups.
  4. The Private Agent receives the request from the messaging service. 
  5. The Private Agent references the OData Service API entity operation in Harmony and triggers the deployed entity operation.
  6. The operation responds with an API payload that is routed from the Private Agent through the Private API Gateway back to the API consumer.

    NOTE: Unless the operation being triggered by the API call is using temporary storage, the API payload will remain on the agent for only two days.

  7. Runtime status information and logs of running operations are sent to the transaction logs database on the Private Agent.

    NOTE: Consumer data is not stored in the transaction logs database unless debug mode is enabled during OData Service configuration.

  8. Logs on the Private Agent can be optionally synced to the transaction logs database within the Harmony. 

For information on configuring an OData Service, see OData Service Configuration.

Proxy API

Unlike Custom APIs or OData Services, which expose a Harmony operation for consumption, Proxy APIs are used with an existing third-party API and are not routed through Harmony Agents. The API being proxied must be accessible to the gateway processing the API, either the Cloud API Gateway or a Private API Gateway:

  • Cloud API Gateway: If using the API gateway that Jitterbit hosts on Harmony, the existing API must be accessible publicly, even if secured. That is, the API you are trying to proxy cannot be behind a firewall. To whitelist the Cloud API Gateway IP addresses to allow the gateway access to the API being proxied, see Whitelist Information and navigate to https://services.jitterbit for your region.
  • Private API Gateway: If using a Private API Gateway, the existing API must be accessible by the Private API Gateway.

This diagram displays how a Proxy API behaves in the system architecture when processed by the Cloud API Gateway:

  1. An API consumer makes a call to the proxy API located at the Cloud API Gateway.
  2. The proxy API call is routed through the Cloud API Gateway and sent to the third-party API being proxied.
  3. The API payload is routed through the Cloud API Gateway back to the API consumer.
  4. The third-party API responds with an API payload that is routed to the Cloud API Gateway back to the API consumer.
  5. Runtime status information is sent to the transaction logs database.

    NOTE: Consumer data is not stored in the transaction logs database unless debug mode is enabled during Proxy API configuration.

For information on configuring a Proxy API, see Proxy API Configuration.

  • No labels