Skip to Content

Turn your connections into holiday cash with our new Customer Referral Program! Learn more

✕

This documentation is for version 4 of App Builder, the new name for Vinyl. Access the Vinyl documentation here.

✕

REST data source in Jitterbit App Builder

Introduction

The REST data source lets you connect App Builder to various REST servers (including other instances of App Builder), or for use with REST objects. A REST data source server's configuration is used across all REST endpoints.

Setting up a REST data source involves the following steps:

  1. Create a REST data source server.

  2. Configure request headers.

  3. Configure query string parameters.

  4. Create REST endpoints for each API method being called.

  5. Add REST endpoints.

  6. (Optional) Override endpoint request/response content types.

  7. (Optional) Configure response pagination.

Create a REST data server

To create a REST data server, follow these steps:

  1. Select IDE > Data Servers.

  2. Click the + Server button.

  3. In the Server Settings section, set the following fields:

    • Server Name: Enter a name for the REST server.

    • Type: Open the menu, then find and select REST API.

    • Url: Enter the URL of the server to connect to.

      Note

      Endpoints are configured in the next section.

    • Request Content Type and Response Content Type: Select the request and response content types. (Typically, REST servers communicate via JSON.)

  4. (Optional) Expand the Security Settings section, then set the following:

    • Security Provider: Open the menu, then find and select the required security provider.

    • User Name: Enter the username for the security provider service.

    • Password: Enter the password for the security provider service.

    Tip

    Most REST APIs use an API key in the header (configured in a later section).

  5. (Optional) Description: Enter a description for this server.

  6. Click the Save button, then close the dialog.

You should see your REST Data Server in the list of Data Servers.

Configure request headers

Most REST services require you to pass in an API key using the request header.

To configure the request header, follow these steps:

  1. Select IDE > Data Servers.

  2. Click the Details button for your new REST data server.

  3. In the Web Service Parameters panel, click the + Parameter button. A new row appears in the panel. Set the values as follows:

    • Type: Open the menu, then select Header.

    • Name: Enter the name of the header parameter. (For App Builder REST servers, the API key is passed using "X-API-Key".)

    • Value: Enter the value of the header parameter.

    • Usage Type: Open the menu, then select the usage type for this parameter.

  4. Click the icon to save the parameter.

Configure query string parameters

If you have common query string parameters to use across end points you can configure them with the following steps:

  1. Select IDE > Data Servers.

  2. Click the Details button for your new REST data server.

  3. In the Web Service Parameters panel, click the + Parameter button. A new row appears in the panel. Set values in the row as follows:

    • Type: Query

    • Name: Enter the name of the query string parameter.

    • Value: Enter the value of the query string parameter.

    • Usage Type: Open the menu, then select the usage type for this parameter.

  4. Click the icon to save the web server parameter.

Add REST endpoints

Once your REST Data Server has been configured, you can add API endpoints.

To add an endpoint, follow these steps:

  1. Select IDE > Data Servers.

  2. Click the Details button for your new REST data server.

  3. In the Endpoints panel, click the + Endpoint button. A new row appears in the panel. Set values in the row as follows:

    • Name: Enter the name of the endpoint.

    • Endpoint: Enter the endpoint. (This value is appended to the REST Data Server URL set in an earlier section.)

    • Method: Select the HTTP method for the endpoint.

  4. Click the icon to save the endpoint.

Override endpoint request/response content types

The default value for Request and Response content types is inherited from the server content type. The available content type values are as follows:

To override the endpoint request or response content types, follow these steps:

  1. In the Endpoints panel, select More > Edge Case. The Endpoint Edge Case dialog opens.

  2. Click the Edit button.

  3. In the Content Type section, set values for the following:

    • Request: Open the menu, then select the overriding request content type.

    • Response: Open the menu, then select the overriding response content type.

  4. Click the Save button, then close the dialog.

  5. To review the proposed query, click the Discover button. The Endpoint dialog opens.

  6. In the Endpoint dialog, click the Discover button to execute the query. This action does the following:

    • Generates input parameters for any sample input entered.

    • Generates output tables for any data coming returned by the endpoint.

  7. Close the Endpoint dialog.

  8. In the Endpoints section, click the Test Connection button, then click the Proceed button to call the endpoint. If input parameters are defined, their test values are sent.

Configure response pagination

To configure response pagination, follow these steps:

  1. Select IDE > Data Servers.

  2. Click the Details button for your new REST data server.

  3. In the Web Service Parameters panel, click the + Parameter button. A new row appears in the panel. Set values in the row as follows:

    • Type: Query

    • Name: Enter the string expected by the service. (Examples include Limit, _limit.)

    • Value: Enter the number of records per page.

    • Usage Type: Open the menu, then select Request Limit.

  4. Click the icon to save the parameter.

  5. Click the + Parameter button. A new row appears in the panel. Choose one of the following pagination methods, then set the values accordingly as follows:

    • Request Offset: Make the service skip a number of records. Set values in the row as follows:

      • Type: Query

      • Name: Request Offset

      • (Optional) Value: Enter the number of records to skip.

      • Usage Type: Open the menu, then select Request Offset.

    • Request Page Number: Fetch a specific page number. Set values in the row as follows:

      • Type: Query

      • Name: Request Page Number

      • (Optional) Value: Enter the number of the page to fetch.

      • Usage Type: Open the menu, then select Request page number.

    • Next Token: Fetch records from a specified point. Set values in the row as follows:

      • Type: Query

      • Name: Next Token

      • (Optional) Value: Enter the key for the record to start from.

      • Usage Type: Open the menu, then select Next Token.

  6. Click the icon to save the parameter.