Skip to content

Overview

Tranquil Data exposes REST APIs supporting three broad categories of use. These APIs are defined and documented using the OpenAPI 3.0 specification. Those definitions are available separately from this documentation, and may be used to generate code and documentation in a variety of formats and languages.

API Interaction#

API calls are made directly to a running instance of the Tranquil DataTM Trusted Flow Edition on its exposed web interface. To test that an instance is running correctly and is responsive to network activity, issue a HEAD request to the root API:

curl --head http://localhost:8890

HTTP/1.1 200 OK
Date: Sun, 13 Oct 2024 18:39:02 GMT

Details about TLS and authentication are covered under API Security. Each of the root URIs described below may be configured to support different authentication mechanisms and may therefore be granted only to specific users.

The API version may be specified using the Accept-Version header. By default it is assumed to be 1.0.0.

API Integration#

Traquil Data has been designed to make adoption simple and incremental. Where you start integrating use of APIs will depend on the first business need you are addressing, but there are a few common points. Most integration starts with the user APIs, once legal or privacy teams have created configuration via the UI, as a way to ensure that first-party users are onboarded with clear and personalized terms and that users re-acknowledge terms as they change. For users that are already onboarded, this will be a chance to pre-populate and stage a solution without effecting live onboarding. Once that integration is done, it's common to define a few mappings via the UI so that business users can start working with the redaction UIs to create value quickly.

From here, integration usually follows one of a few paths depending on immediate needs: automating contract definitions in configuration, capturing third-party users and origin of third-party data, or instrumenting decision-making into transforms and AI pipelines are the most-common next-steps. What follows are a series of examples framing each section of APIs. These aren't just to give you REST syntax, but they're also to help you understand motivation and map to your needs.