Welcome to ONLYOFFICE API
ONLYOFFICE API describes the main methods that allow you to interact with different ONLYOFFICE components.
Please select the necessary section below to learn more about which API methods are available for it.
Frequently Asked Questions
If you do not know where to start with Document Server API, we suggest that you first read the Basic concepts and How it works sections to have better understanding of how Document Server API is built. Once you are familiar with the main concepts, you can visit the Try now section to see the live examples of the main Document Server features in action...
Read more
The current Document Server version number can be found at the About page of the Document, Presentation or Spreadsheet Editor, right below the logo and the editor name. You can use the API to send a POST request to the document command service. Use the c parameter for that with the version value, which is sent as a JSON object in the request body...
Read more
All the main settings for Document Sever are stored in the default.json configuration file which is available in the /etc/onlyoffice/documentserver/ folder (for Linux) or %ProgramFiles%\ONLYOFFICE\DocumentServer\config\ (for Windows). There is also the platform-specific production.json file in the same folder...
Read more
To prevent an unauthorized access to your documents and the substitution of important parameters in ONLYOFFICE Document Server requests, it uses a JSON Web Token (JWT) compatible tokens to ensure security. The tokens are signed by the server key, so the client is able to verify that the token is legitimate...
Read more
Starting with version 5.2 of Document Server it is possible to send token both in the request header and body. The main difference between these two methods is in the length limitation: a HTTP header has length limitation and some servers (such as some NGINX versions) do not accept the requests with the header longer than 4 kilobytes...
Read more