Public API

3rd June, 2024

Introduction to the Public API

The Public API is an interface designed to help our users integrate Dataedo with other tools. In version 24.2, we're releasing the first iteration of the API. It primarily allows for data fetching but also supports updating and creating certain objects.

Current and Future Capabilities

Here is a brief summary of what is currently possible and what will be possible in the near future.

Image title

Configuration

The API uses HTTP POST and HTTP GET methods. If you have already updated Dataedo to version 24.2, you don't need to take any additional steps to set up the Public API, as it is already part of the hosted backend application on your server. However, authorization is required to use the Public API endpoints. Please refer to the Authorization section for detailed instructions on obtaining and using the authorization token.

Please note that access to the Public API requires an appropriate license. Make sure your license plan is "Dataedo" or you are using a trial license. If you are using an offline license, it may be necessary to download a new license and reapply it to the system. To proceed, please visit the Dataedo License Portal.

Authorization

To use the Public API endpoints, you need an authorization token, which you can find in your system settings. Go to the API tab and ensure the connection to the API is turned on. Once the connection is active, Dataedo Portal will generate a token, which is hidden by default. This token is a JSON Web Token (JWT). To make the token visible, click on the eye icon. Make sure to save the settings before quitting the page.

Image title

This authorization token is required for accessing all Public API endpoints. You must include an Authorization header in your HTTP requests, with the value set to the generated token prefixed by Bearer.

For example: Authorization: Bearer your_generated_token

Please note that personal JWTs are not permitted for accessing Public API endpoints.

Reference

You can access it via my.company.dataedo.com/api/public/v1. A list of available endpoints and their parameters can be found at https://dataedo.github.io/public-api-docs/.

Found issue with this article? Comment below
Comments are only visible when the visitor has consented to statistics cookies. To see and add comments please accept statistics cookies.
0
There are no comments. Click here to write the first comment.