Synchronize data via API using custom application integrationTo synchronize data with Relatics from an external application an interface is needed.
Configure an interface in the workspace*
- In the workspace menu, click on
Application integration. - In the Application integration view, click on
New interface for synchronizing with an external application. As a result, the dialog Create interface for synchronizing with an external application is opened. - For the field Name, enter a text representing the use.
- For the field Type element (with ownership in an external application), select the desired external type element.
- For the field Setup, select Custom.
- For the field Initiator, select External application (via API request).
- For the field Relatics API key for requests by external application, select the desired requests key.
- For the field Endpoint, enter a text that represents the data.
- Click Create. The interface is created and ready to be used.
New interface for synchronizing with an external application. As a result, the dialog Create interface for synchronizing with an external application is opened.Synchronize data via API request
An HTTP POST request is required to upload data to Relatics. The request consists of an endpoint URL, headers, and a body:
- You can submit the POST request to the Interface endpoint URL. This URL can be found on the detail page of the interface and should look something like this:
https://myenvironment.relatics.com/api/v1/workspaces/755053b0-ba42-494a-b467-8c2cf408be65/interfaces/synchronizing/myendpoint
- The headers that need to be set are described in the table below:
| Key name | Value | Description |
|---|---|---|
| Authorization | string | “Bearer {Access_token}”
Where:
|
| Accept | list | The structure type of response body. The options are:
The default is application/json. |
- In the request body, supply the complete set of elements. The data should be structured in either JSON or XML format, corresponding to the specified structure in the request header.
If successful, the web server returns an HTTP status of 200. This means that the presented request body has the correct structure. To see if the data is processed successfully, you can check the Sync issues log of the interface or the elements in the type element overview.
Notes:
- Only properties and relations where the data ownership is configured as external can the value be changed in the request.
- Elements not supplied in the request body will be deleted.
* In the workspace, the user type of your user must be set to power user to use this feature.
