The onOffice API (API) processes every valid JSON document (JSON). Indentations, spaces and line breaks have no effect on the processing. To ensure the lowest possible transmission data and the avoidance of possible error sources, the response is delivered without any formatting. The response is also valid JSON.
To better illustrate the JSONs used in the API, they are indented and wrapped if necessary.
As authentication of the client, OAuth is used. If the client is still unknown, the authentication is done using the normal enterprise login data (user credentials). In the following, the authentication is only done by OAuth access tokens, which are added to each request.
TLS 1.2 is used to connect to the API server.
The request URL for the latest API version is https://api.onoffice.de/api/latest/api.php.
The request URL for the stable API version, which is updated monthly, is https://api.onoffice.de/api/stable/api.php.
Note that the request URLs for the stable and latest API always remains the same for all requests. The individual endpoints are addressed via the actionids in the JSON.
The onOffice SDK is available on GitHub and can be downloaded there.
Note:
If you are using a live client, it will automatically redirect to the stable API version, no matter what API version you set.
If you are using a beta client, it will automatically redirect to the latest API version, no matter what API version you set.
Internal API calls: The internal API calls section lists calls that are used for communication within our own software environment. They are not intended for external use.
The onOffice API is available to all enterprise customers as a paid module. For the exact conditions please contact your sales contact at onOffice.