Provide data via API using custom application integration

Provide data via API using custom application integration

To provide project data from Relatics to an external application an interface is needed.

Configure an interface in the workspace*

  1. In the workspace menu, click on Application Integration.
  2. In the Application integration view, click on New interface for providing data to an external application. As a result, the dialog Create interface for providing data to an external application is opened.
  3. For the field Name, enter a text representing the use.
  4. For the field Type element, select the desired type element.
  5. For the field Relatics API key for requests by external application(s), select the desired entrance key.
  6. For the field Endpoint, enter a text that represents the data.
  7. Click Create. The interface is created and ready to be used.

Note:

  • Only standard type elements can be selected as a type element for an entry interface. Elements of the inner types cannot be selected.

Provide data via API request

An HTTP GET request is required to get data from Relatics. The request consists of an endpoint URL, headers, and a body:

  • You can submit the GET 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-c2cf408be65/interfaces/providing/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:

  • application/json
  • application/xml

The default is application/json.

  • A request body is not needed for this method.

 

If successful, this method returns the elements in the response body. Depending on the specified value of the ‘Accept’ key in the header, the response will be in json or xml.

Notes:

  • You can use the http status to track the success of the request.
  • The response is limited to the ID and display name of the elements.
* In the workspace, the user type of your user must be set to power user to use this feature.
Back
Schakel JavaScript in je browser in om dit formulier in te vullen.

Download the whitepaper

Schakel JavaScript in je browser in om dit formulier in te vullen.

Download the whitepaper

Request a demo

Fill in the below information and we will contact you to schedule a demo.

Schakel JavaScript in je browser in om dit formulier in te vullen.
We will use this information to contact you.
Schakel JavaScript in je browser in om dit formulier in te vullen.
Schakel JavaScript in je browser in om dit formulier in te vullen.
Addresss

Neem contact op

Vul ons formulier in en een van de Relatics medewerkers neemt zo snel mogelijk contact met u op. Liever telefonisch contact? Bel ons op +31 (0) 180 413 047.
Schakel JavaScript in je browser in om dit formulier in te vullen.