Job Configuration - Import - API Connector

This section explains how to configure an import job via the API Connector, allowing DJUST to retrieve data from your REST API.


✅ Prerequisites

Before configuring a job, make sure you have:

  • A configured API Client (see how to configure an API client).
  • Your system exposes a REST API that DJUST can query.
  • The payload structure complies with the expected format for the selected entity (see individual entity documentation). For more details on how to comply with the expected payload format for each data entity, refer to this page: Data Hub Mapping Overview.

⚙️ API Connector Import Job Configuration

Creation

To configure an import job from the DJUST back office:

Step 1 – Access the Data Hub

  1. Go to the Data Hub section.
  2. Click + Create a new job.
  3. Select Import.
  4. Choose the API object you want to import (e.g., Products, Suppliers, Orders).

Step 2 – Job configuration

Basic information

  • Job name (must be unique)

  • Client: select your API Client

  • Scheduler: choose frequency (:warning: displayed time is in UTC)

    FrequencyOptions
    MinutesEvery X minutes
    HourlyEvery X hour and X minutes<br>Or a specific hour
    DailyEvery X days at a specific hour<br>Or every weekday at a specific hour
    WeeklyTick the day(s) for the job to run at a specific hour
    MonthlyDay X of every month<br>Or last day of the month<br>Or last weekday of every month<br>At a specific hour
    CustomProvide a custom cron expression

Api calls

  • Configure the API calls that DJUST will use to fetch data from your system.
💡

Chained API calls

You can add more calls by clicking + Add a call.

Each call is run sequentially.

  • Choose the HTTP method (GET, POST, etc.) that matches your endpoint's requirements.
  • Select the behavior and fill in the parameters if applicable

Behavior

Purpose

Key Configurations

Example Use Case

Retry

Retry a request until a condition is met

Max attempts, interval (sec), expected status, condition key & value

Poll an endpoint until a file becomes AVAILABLE

Download

Retrieve a file from a URL

Method = GET, behavior = Download, URL field from previous response

Download a CSV file once its URL is returned by a previous API response

Pagination

Loop through paginated API responses

Page number, page size, total pages or total records

⚠️ The Content Finder Path must be specified to locate the parameter containing the data to be imported.\ Use the JSONPath format: $.{parameterName} — for example, $.items or $.data.results.

Retrieve full product catalog from an endpoint using page-based pagination

💡

API Behavior

The Behavior setting controls how DJUST processes the response or loops through API calls. It is key for retry logic, pagination, or downloading external files.

  • Define optional query parameters
  • Add optional path variables
💡

Path Variables

Inject dynamic values from previous API responses directly into the URL path.

Example: /products/{productId} where productId is extracted from a previous API response ($.id).

Mapping

  • Map each field from your API response to the appropriate DJUST field to ensure proper alignment with the platform's data model.

⚠️Some fields might be required. For more details on how to configure mappings for each data entity, refer to this page: Data Hub Mapping Overview.


Manage and Update

Once your API import job is created, you can manage it from the Data Hub interface:

  1. Go to the Data Hub > Import section.
  2. In the list of jobs, locate the job you want to update.
  3. Click the ⚙️ icon to open the configuration.

Update

  1. You can update any of the following:
    • API client
    • Scheduler
    • API calls configuration
    • Mapping
  2. Click Save to apply changes.

Activate, Disable or Delete an Import Job via API Connector

  1. In the Data Hub section, locate your job.
  2. Click More actions.
  3. Choose one of the following actions:
    • Activate: to enable the job.
    • Disable: to pause the job.
    • Delete: to permanently remove the job (⚠️ This action is irreversible).