The API Connector enables secure and direct communication between an external system and the DJUST platform via RESTful APIs. With this Connector, users can programmatically import and export data, ensuring real-time synchronization with third-party services such as ERPs, PIMs, or custom data hubs.

Prerequisites

Before configuring an API Connector, make sure you have the following:

• A RESTful API server to interact with (e.g., ERP or middleware system).
• Connection information:
  • Base URL (e.g., https://api.company.com)
  • Optionally: request headers
• For OAuth2 authentication (if required):
  • Access token URL
  • Client ID and Client secret
  • (Optional) Username and Password for password grant type

Configure an API Connector in DJUST

Create an API Connector

Step 1 – Access the Data Hub

• Go to the Data Hub page from the DJUST back office.
• Click on Configure a new Connector
• Select the Connector type and choose API Connector.

Step 2 – Configure Connection Settings

• Fill in the following mandatory fields:
  • Connection name (must be unique)
  • Base URL of your API server
• In the Authentication section, choose the method:
  • No Auth – if the API is public or handles auth in another way
  • OAuth 2.0 – if secure authentication is needed
• If OAuth2 is selected, provide:
  • Access token URL
  • Client ID and Client secret
  • Optional: Username and Password (for password grant type)
• You can also add custom request headers (e.g., Authorization, X-API-Key, etc.)

Step 3 – Save the Configuration

• Once all fields are filled in, click on Create to save the API Connector.

Manage an API Connector

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

• Go to the Data Hub page
• Select Connector
• Choose the API connection you want to modify

Update

• Change any setting (Base URL, headers, credentials, etc.)
• Click Save to apply your changes

Activate, Disable or Delete an API Connector

• Click More actions
• Choose:
  • Activate: to enable the Connector
  • Disable: to deactivate the Connector
  • Delete. Click Delete and confirm (⚠️ This action is irreversible).

Effect on the imports and exports of the Connector

📘

Note: Since 3.139, reactivating a Connector no longer reactivates the jobs it carries. Reactivate the imports and exports you want to restart, one by one. An import reactivated while the Connector was inactive resumes its schedule as soon as the Connector becomes active again.

Secrets returned masked

The secrets are returned masked, in the format already used elsewhere on the platform: ******* followed by the last three characters.

On read — GET /v1/mapper/client and GET /v1/mapper/client/{clientId} return these fields masked.

On write — PUT /v1/mapper/client/{clientId} and PATCH /v1/mapper/client/{clientId}: a value that is empty or still masked keeps the stored secret; only a new value replaces it. Saving a connector again without retyping its secrets therefore no longer alters its configuration — including an OAuth2 password grant connector, whose password used to be lost on any update made without re-entering it.

All endpoints require dj-client: OPERATOR and a valid dj-api-key.