Skip to end of metadata
Go to start of metadata


This page shows how to create a simple Jitterbit Custom API using Design Studio. The same can be done using Cloud Studio following similar steps.

Create the Operation

  • Assume that we want an external system to call our integration operation. 
  • In this example, this operation reads a database table and processes the data into an XML output.

  • The API Response is chosen as the output, meaning that the output of the transformation will be returned to the calling system.

Create the API

  • Next, go to the Web Management Console to build the API.
  • Select Menu.
  • Select API Management.
  • Select Custom API.
  • Select the New Custom API Service button.

  • Select the Environment of the project from the drop-down list.
  • Enter a name for the API in the Name field.
  • Enter a short description in the Description field.
  • Enter a version in the Version field.

  • Select a Method Type (GET/PUT/POST/etc) from the drop-down list, or leave it unassigned.
  • Select your Project from the drop-down list.
  • Select the Operation to call from the drop-down list..

  • In this example, final target is selected for the Response
  • Security Profiles can also be added. See Harmony API Security for more information
  • Select Assign and select the appropriate Profile.
  • Click Add to save.

Testing the API

  • To test, click on Action.
  • Select Copy URL to Clipboard from the drop-down menu.

  • Paste the URL into a browser.

  • The Operation responds with XML output:

Using a System Variable Response

Note: See API Jitterbit Variables for the complete list of API system variables.

  • For the next example, select system variable as the Response.
  • Click on Action and select Edit in the drop-down menu.
  • Select system variable for the Response.

  • Select Update.
  • The following message will display:

  • Keep this message in mind. Change the operation Target from API Response to a temporary file and add a simple script at the end to populate the correct variable.

  • Script example:

  • This approach can be used to immediately send an acknowledgement and then proceed to process data. Or, it can be used to perform some other actions and respond with a different output.
  • Pro Tip: Be sure to deploy your operation changes. Since the operation is called by an external source, it will not automatically deploy changes you have made in the Studio.

  • This method for enabling external calls into Jitterbit operations is similar to using HTTP Endpoints (see Create a Hosted HTTP Endpoint). One major difference is the logging capabilities.

View API Logs

  • In the Web Management Console, select Menu and select API Analytics.
  • Select View Debug Logs.

  • In the Debug Logs you have a great deal of searchable information about the inbound call, which is not available if an HTTP Target is used. 

  • To have the called operation listed in the Activities Log (available as of version 8.12), it is necessary to enable Debug Logs in the API page.

  • The debug log can also be downloaded for additional information as indicated by the small blue icon at the right end of a row:

On This Page

Last updated:  Apr 16, 2019