Skip to content

API

The DocSecBox has an application programming interface (API). It lets other programs connect to the DocSecBox, for example to upload or retrieve files automatically or to include them in your own workflows.

Paid add-on module

API access is a paid add-on module. Without the module, there is no API entry in the settings.

Set up the API

An administrator sets up the API under Settings › Application › API (see API):

  1. Allow access from internal addresses, external addresses, or both.
  2. Register the program that is to use the API as an application.
  3. Select the users who receive a key for it.

Each of these users finds their key in their own profile under Third-Party Keys.

Specification

The complete specification of the interface (OpenAPI) is available on request from the operator of your DocSecBox or from the manufacturer.