Configure Data Exchange API endpoints

This document describes how to create and configure the Data Exchange API endpoints.

The Data Exchange API lets you create endpoints to interact with any database tables through API. In this example, we are creating the /dynamic-data/countries endpoint to interact with the spy_country and spy_tax_rate tables. When following the steps, adjust the data per your requirements.

Create and configure a Data Exchange API endpoint

To register an endpoint for interacting with entities in the database, you need to add a corresponding row to the spy_dynamic_entity_configuration table. The table contains the configuration of dynamic entity endpoints and has the following columns:

You can optionally create a relation by adding new rows to spy_dynamic_entity_configuration_relation and spy_dynamic_entity_configuration_relation_field_mapping tables. The spy_dynamic_entity_configuration_relation contains the configuration of relations for dynamic entity endpoints and has the following columns:

spy_dynamic_entity_configuration_relation_field_mapping contains the configuration of relation field mapping for dynamic entity endpoints and has the following columns:

The following example shows a possible value of the spy_dynamic_entity_configuration.definition field configured for the spy_country table:

{
  "identifier": "id_country",
  "isDeletable": false,
  "fields": [
    {
      "fieldName": "id_country",
      "fieldVisibleName": "id_country",
      "isEditable": false,
      "isCreatable": false,
      "type": "integer",
      "validation": {
        "isRequired": false
      }
    },
    {
      "fieldName": "iso2_code",
      "fieldVisibleName": "iso2_code",
      "type": "string",
      "isEditable": true,
      "isCreatable": true,
      "validation": {
        "isRequired": true,
        "maxLength": 2,
        "minLength": 2
      }
    }
  ]
}

and for spy_tax_rate table:

{
  "identifier": "id_tax_rate",
  "isDeletable": false,
  "fields": [
    {
      "fieldName": "id_tax_rate",
      "fieldVisibleName": "id_tax_rate",
      "isCreatable": true,
      "isEditable": true,
      "type": "integer",
      "validation": { "isRequired": false }
    },
    {
      "fieldName": "fk_country",
      "fieldVisibleName": "fk_country",
      "isCreatable": true,
      "isEditable": true,
      "type": "integer",
      "validation": { "isRequired": false }
    },
    {
      "fieldName": "name",
      "fieldVisibleName": "name",
      "isCreatable": true,
      "isEditable": true,
      "type": "string",
      "validation": { "isRequired": true }
    },
    {
      "fieldName": "rate",
      "fieldVisibleName": "rate",
      "isCreatable": true,
      "isEditable": true,
      "type": "float",
      "validation": { "isRequired": true }
    }
  ]
}

Enable and configure the Data Exchange API endpoint in the Back Office

1. In the Back Office, go to Data Exchange API Configuration.
2. On the Data Exchange API Configuration page, click Create Data Exchange API configuration.

3. In CREATE DATA EXCHANGE API CONFIGURATION pane, for TABLE NAME, select the table you want to configure the API for. In our example, it’s spy_country.

4. Click Create. This opens the EDIT DATA EXCHANGE API CONFIGURATION page.
5. For RESOURCE NAME, enter the name of the endpoint you want to create. In our case, it’s countries.
6. Optional: To enable the endpoint after it’s configured, select IS ENABLED.
7. Configure the fields for interactions per your requirements.

7. Click Save. This opens the Data Exchange API Configuration page with the endpoint displayed in the list. Now you can send requests to this endpoint.

Download Data Exchange API specification

You can download the specification of all the available endpoints, including the Data Exchange API endpoints, in the OpenAPI format. To download the specification, go to the Data Exchange API Configuration page, click Download API Specification. This initiates the download of the specification to your computer.

In case you’ve added new endpoints, the documentation will be automatically updated with the new information after a minute. The Download API Specification button is inactive during the documentation update process and becomes available again after one minute. There is a notification about this at the top of the page:

Next steps

Send request in Data Exchange API