Integration API introduction

In this section:

Controlant develops next-generation solutions that help reduce the staggering losses in today's temperature-controlled pharma supply chains. For more information, see controlant.com.

Here you will find everything you need to know about how to connect your internal systems to our product offering via the platform integrations.

API

You can use the Controlant Integration API to connect your internal systems to Controlant's systems and automate the processes involved in creating, managing and tracking shipments in Controlant's systems.

The API is organized around REST.
Our API accepts application/json JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication and verbs.
You can use the API to create, manage and track shipments created in Controlant Systems.

Brief technical overview

Versioning

The current version of the integration API is v1 and is considered to be in a early release phase.

While we do not expect public endpoints to change much, keep in mind that the API is still under development.

Note

All requests must contain the x-api-version header. Currently only the value 1 is supported:

$ curl -H 'x-api-version: 1' -X https://integrations.controlant.com/api/echo

HTTP verbs

The Controlant Integration APIs exclusively use the POST HTTP verbs.

Parameters and data

Any parameters not included in the URL should be encoded as JSON with a Content-Type of application/json:

$ curl -i <https://integrations.controlant.com/api/projects/1/groups/> \
    -d '{"status": "resolved"}' \
    -H 'Content-Type: application/json'

Additional parameters are sometimes specified via the query string, even for POST, PUT, and DELETE requests:

$ curl -i <https://integrations.controlant.com/api/projects/1/groups/?status=unresolved> \
    -d '{"status": "resolved"}' \
    -H 'Content-Type: application/json'

Endpoints

You can find a full list of the currently supported API endpoints at integrations.controlant.com/api-reference.