Developer Tools

Developer Tools

The Developer Tools section is used to integrate, extend, and automate ONLYOFFICE Docs and Apps: connect editors to your own platform with Docs Connect, integrate ONLYOFFICE Apps into your own web application with Embed SDK, use Plugin SDK, webhooks, add OAuth applications and API keys.

The Overview page opens by default. It lists all the available developer tools with a short description of each one. Click the link on the corresponding card to get started.

By default, access to the Developer Tools section is enabled for all users except guests so that any user can access this page, accordingly, create own webhooks or own OAuth 2.0 apps, etc. If you want to make the Developer Tools page accessible to the workspace owner and administrators only, disable the Developer Tools section setting in the Security section.

Docs Connect

The Docs Connect section allows you to run the ONLYOFFICE document editing engine in the cloud and embed it into your own product. Instead of installing and maintaining ONLYOFFICE Docs on your own server, you create an instance that is hosted for you and provides the document, spreadsheet, presentation, and PDF editors to your users.

The instance does not depend on a particular storage: it can be linked to the platforms you already use via ready-made connectors, or to your own application via API. A single instance can serve several platforms at once, so there is no need to create a separate one for each integration.

The Dev Pack extends the instance with the Automation API for automating actions in the editors and with the branding options that allow you to replace the default branding with your own. Use the Read API documentation link to open the developer documentation with the integration details.

The instance can be tested free of charge for 30 days, with the Dev Pack features included and no payment details required. To create your first instance, click the Start free 30-day trial button.

note

Docs Connect can also be activated in the Billing -> Add-ons section.

Once the instance is created, the Statistics, Settings, and Preview tabs become available. While the trial lasts, the number of the remaining free days is displayed next to the Docs Connect title. Use the Subscribe button to switch to a paid subscription before the trial expires.

Use the options icon next to the Docs Connect title to copy the secret key, upgrade the subscription, or view the transaction history.

Statistics

The Statistics tab displays the information about your instance:

• System overview - the instance Address, JWT header, and Secret key. Use the corresponding icons to copy the values or to show the hidden secret key.
• License - the license start date, the date until which the license is valid, and the number of the remaining days.
• Build - the build type, version, and release date.
• User activity in the last month - the unique user activity for Editors (document editors with full permissions) and Live Viewer (read-only document viewers). For each of them, the usage as well as the number of the active, internal, external, and remaining users are displayed.

Click the Download report button to download the user activity report.

Settings

The Settings tab allows you to configure your instance. In the General section, the following settings are available:

• JWT header, Secret key - view or change the JWT header and the secret key. Use the corresponding icons to show the hidden secret key or copy it.
• WOPI - turn on the Enable WOPI protocol switcher to allow integrations with WOPI-compatible storage providers.
• Anonymous support - select Yes to allow users without authentication to access documents, or No if only authenticated users can access documents.
• File size limits - specify the maximum number of bytes that can be downloaded for document processing (e.g., 104857600 = 100MB).

Click the Save button to apply the changes or the Cancel button to discard them.

The IP Filtering section allows you to configure the Access Rules that define which addresses can reach your instance. Each rule either allows or denies access for an IP address, an IP range, or a host, and is listed with its type and value.

note

By default, the list contains a single Allow rule with the * value, which permits access from any address.

Click the Add Rule button to add a new rule. To delete a single rule, use the corresponding icon on the right.

To remove every rule at once, click the Reset button and confirm the action in the Reset access rules window that opens. All the allow and deny rules are deleted permanently, and access is allowed from any IP address until you add new rules.

Preview

The Preview tab allows you to check how the editors work:

• Editor - open a sample document in the embedded editor. During the trial period, the editor is opened in the trial mode.
• Demo code - view the sample code for embedding the editor with your instance address and configuration. Use the corresponding icon to copy the code.

Embed SDK

Use the ONLYOFFICE Apps SDK based on JavaScript which allows developers to use all the capabilities of ONLYOFFICE Apps with api.js. You can integrate ONLYOFFICE Apps into your own web application, allowing users to create and submit documents directly from your website. To learn more about using Embed SDK, read this guide

For more details on Embed SDK, please refer to api.onlyoffice.com.

Plugin SDK

Use the Plugin SDK to extend your workspace functionality, connect third-party services, or enhance the user experience with custom features. The Plugin SDK page also provides a collection of ready-made plugin samples with source code available on GitHub.

To get started with building your own plugin, use the Read instructions link on the Plugin SDK page for a step-by-step guide.

note

Sample plugins are not enabled automatically. Go to the Plugins page to enable them for your workspace.

Plugin samples

The Plugin samples section lists officially supported plugins. For each plugin, its version and a short description are displayed. Click the Go to repository button on the corresponding card to open its source code on GitHub. The following plugins are available:

• codemirror — view and edit files containing programming code in a wide range of formats.
• markdown — view, edit, and create Markdown (.md) files directly in your workspace.
• convert-to-markdown — convert DOCX, TXT, and HTML files to Markdown format without leaving your workspace.
• zip-archives — open and extract ZIP archives stored in your workspace.
• speech-to-text — transcribe audio to text using speech recognition directly within your workspace.
• pdf-converter — convert documents, spreadsheets, presentations, and forms to PDF format.
• url — create, edit, and open URL files with external links from within the file list.
• book-reader — open supported files in a dedicated full-screen reading viewer.
• draw.io — create and edit diagrams using the draw.io diagramming tool.
• image-editor — edit images directly within your workspace.

Plugin capabilities

Plugins built with the Plugin SDK can make use of the following features:

• Localization — plugins support multiple languages via the built-in localization mechanism.
• CSS customization — apply custom styles to your plugin interface using standard CSS.
• Group menu actions — add custom actions to the group selection menu for files, folders, and rooms.
• Custom selectors — display built-in workspace selectors (basic, file, room, groups, users) within your plugin.
• Floating action button — add custom operations with custom icons to the floating action button, including progress indicator.
• Sidebar slots — place plugin entry points in the sidebar using 32×32 px icons. Up to 5 slots are available.
• Context menu actions — display plugin-specific actions in the context menu for a particular file, folder, or room.
• Media viewer integration — embed your plugin directly into the built-in media viewer.
• UI components — use the built-in IconButton and Link components for a consistent look and feel.

For more details on Plugin SDK, please refer to api.onlyoffice.com.

Webhooks

Use webhooks to perform custom actions on the side of any application or website you are using based on various events in ONLYOFFICE Apps. You can create and manage all your webhooks, configure them, and browse history of every webhook to audit their performance. To learn more about using webhooks, read this guide.

To create a webhook, click the Create webhook button and fill in the form:

• Webhook name - specify the webhook name.
• Payload URL - specify the URL the webhook payload will be sent to.
• Secret key - enter the secret key or use the Generate link to create it automatically.
• SSL verification - select the Enable SSL verification option or the Disable (not recommended) option.
• Event to trigger this webhook - select the Send everything option, or Individual events to specify the necessary events only.
• Target ID - specify the target ID.

Click the Create button.

For more details on the Apps API, please refer to api.onlyoffice.com.

OAuth 2.0

Use OAuth 2.0 to access the ONLYOFFICE Apps API for authorization and further actions such as accessing files, etc.

To create a new application,

1. Click the Register a new application button. The New application page opens.

   

2. Fill in the Basic info section:

   • App name - an application name that will be displayed on all consent screens and in the application list. Obligatory parameter.
   • Website URL - a link to the site home page. Obligatory parameter.
   • App icon - an image that will be displayed on all consent screens and in the application list. Use the Select new image option to upload a JPG, PNG, or SVG file, 32x32. Obligatory parameter.
   • Description - a short description of the application.
   • Authentication method - a verification method when receiving a JWT token. To receive a token it's necessary to send the SHA key. Check the Allow public client (PKCE) box if necessary.

3. Fill in the OAuth URLs section:

   • Redirects URLs - links that the user can be redirected to after successful passing the consent screen. Enter the address and click the Plus button. You can add several links, for example, for test and production versions. Obligatory parameter.
   • Allowed origins - URLs of sources that can make requests to the Apps API without CORS blocking. Enter the address and click the Plus button. You can add several links. Obligatory parameter.

4. In the Access scopes section, define the capabilities of a third-party application relative to the Apps API. Scopes are used to limit your app's access to all user-related data, and they'll let you specify exactly what kind of access you need. Check the Read or Write box next to the necessary options. When selecting a capability for writing data, it automatically enables reading data. Obligatory parameter.

   

   • Profile - accounts.self:read to view basic information about your profile, accounts.self:write to view and manage basic information about your profile.
   • Contacts - accounts:read to view all contacts, accounts:write to view and manage all contacts.
   • Rooms - rooms:read to view all rooms, rooms:write to view and manage all rooms.
   • Files & Folders - files:read to view all files and folders, files:write to view and manage all files and folders.
   • Open ID - openid to view your personal data. This scope is available for reading only.

5. Fill in the Support & Legal info section:

   • Privacy policy URL - a URL link to your Privacy Policy that must comply with applicable laws and regulations and that make clear how you collect, use, share, retain and otherwise process personal information. Obligatory parameter.
   • Terms of Service URL - a URL link to your Terms and conditions that users must comply with when using this application. Obligatory parameter.

6. Click the Save button.

You can manage your created apps in the list:

• View info about your app: app name, creator, modified date, scopes.
• Disable or enable the app using the State switcher.
• Right-click the app and select the necessary option:
  • Edit - to change some parameters, such as App name, App icon, Description, Authentication method. On this page, you can also copy the Client ID and Secret or reset the secret if necessary.
  • Auth button - to view the authorization button, copy the HTML, CSS or JavaScript code to embed it into your website, get an authorize link or code verifier. By clicking the authorization button, you can also go through the entire flow.
  • Info - to view the app info, such as creator, description, website, access, scopes, support and legal info, last modified date.
  • Generate token - to generate a token for development (so that not to go through the flow each time). The generated token has a limited lifetime and will be automatically deprecated when a new one is created.
  • Revoke token - to revoke the generated token.
  • Disable - to disable the app and stop all active sessions.
  • Delete - to delete the app and stop and remove all active sessions.

When following the authorization link, there are 3 possible scenarios:

1. If the user is not yet authorized on the workspace, the authorization form opens. After successful authorization, the user will be redirected to the step 2 or 3.
2. If the user has more than one workspace, it will be possible to select the necessary one.
3. If the user is already authorized on the workspace, they will be redirected to the consent page, which displays the capabilities of the application, links to the security policy and terms of service. The user can click the Allow or Deny button as well as choose another profile.

For more details on the Apps API, please refer to api.onlyoffice.com.

API keys

As an owner or admin, you can view and manage all API keys for this workspace. To learn more, use the Read the API guide link.

note

Keep your API keys private - do not share them or expose them in the browser or other client-side code.

To create a new API key,

1. Click the Create new secret key button.
2. Fill in the form:

   • Name - Specify the secret key name.

   • Permissions - Select the necessary option:

     • All - Enable read and write permissions to all sections.

       

     • Restricted - Enable read or write permissions to certain sections. In the Access scopes list, check the Read or Write box next to the necessary options: Files & Folders, Rooms, Profile, Contacts. When selecting a capability for writing data, it automatically enables reading data. The Generate button becomes active only after at least one access scope is selected.

       

     • Read only - Enable read only permissions to all sections.

       

   • Key lifetime - Turn on this switcher to automatically deactivate the secret key after a defined period, then specify the number of Days (365 maximum). The lifetime starts from the moment the key is created.

3. Click the Generate button.
4. In a new window, copy the generated key and click Done.

You can manage your created API keys in the list:

• View info about your key: Name, Secret key, Created, Last used, Created by, Permissions.
• Disable or enable the key using the State switcher.
• Right-click the key or use the options icon on the right, and select the necessary option:
  • Edit - to change the key Name and Permissions.
  • Delete - to delete the key.

For more details on the Apps API, please refer to api.onlyoffice.com.