API integration

The GDPR software exposes a set of APIs that allow fine-grained integration with client applications. This article is intended for developers and/or project managers. It describes the integration procedure and the prerequisites.

Steps

Obtain the API keys
Integrate in Sandbox environment
Go live

OpenAPI documentation

The APIs are exposed in json/Rest format. The interface contracts and data schemas are documented in OpenAPI 3.0 and available at the following address:

https://dld-sandbox.datalegaldrive.com/api/v1/api-docs

This technical document is protected. You must first log in to the GDPR software at https://dld-sandbox.datalegaldrive.com/#/login to access it.

These interface contracts can be used to generate query/response templates in any program that supports OpenAPI (e.g. https://redocly.github.io/redoc/).

Securing the APIs

The APIs are protected through an API key system. A key consists of an AccessKey and a SecretKey. To obtain your set of keys, please contact DLD Support.

Each API key is tied to a specific entity. It only allows you to work within the scope of that entity.

Authentication information is supplied by sending an http header in the following format:

1 x-api-key: accessKey={ACCESS_KEY};secretKey={SECRET_KEY}

The keys are specific to each environment.

Revoking the keys

If your API keys have been compromised, please inform DLD Support immediately so they can revoke your keys and generate new ones.

Environments

Two environments are available:

An integration environment for testing and implementation:
https://dld-sandbox.datalegaldrive.com/
The data in this environment is not saved or replicated. The databases may be initialized by the Data Legal Drive engineering team at any time.
The live environment:
https://dld.datalegaldrive.com/