The API in enaio® coLab

 

A REST API is available for enaio® coLab, which provides endpoints that make it possible to control the lifecycle of a project room from external applications.

Use Case (Example)

For example, when creating a new business transaction, it is possible to use a script to automatically create a project room for this business transaction. The persons involved in the business transaction can be invited via the API using their e-mail address. The API can then be used to check whether the invitations have been accepted. Once the business transaction has been completed, the project room can be deleted again using a script, for example, controlled by a status in the index data field.

Authorization

Use of the API requires authorization via a token. coLab administrators can create and delete tokens. Tokens are created or deleted in the Admin settings > API area in the enaio® coLab client.

The token is part of the API request. The request to the API must contain the token and all necessary data relevant to the called endpoint (root object ID, user ID, invitation e-mail, etc.). The token can have a limited period of validity.

The API calls are logged (including various log levels) to make error analysis easier. API calls return detailed error information if error documentation exists.

You can find detailed API documentation under API for project room management .