Filez Docs Platform API vs WOPI
You can integrate Filez Docs Platform with any service using either the Filez Docs Platform API or WOPI.
These two approaches offer different capabilities. The table below helps you understand the differences between them.
| Filez Docs Platform API | WOPI | |
|---|---|---|
| General info | Application Programming Interface / REST API: describes the primary ways to interact with Filez Docs Platform, allowing you to access it programmatically via REST APIs. Learn more | Web Application Open Platform Interface: Microsoft’s REST-based protocol defining a set of operations that enable a client to access and change server-stored files. Learn more |
| Supported actions | - Basic actions such as view, edit, co-editing - Supports user search - Supports comment notifications - Supports force track changes mode - Supports show comments and track changes in preview - Supports select user permissions - Supports comment mode - Supports auditor mode - Supports file comparison | - Basic actions such as view, edit, co-editing - Supports user search (by additionally implementing Filez Docs Platform APIs) - Supports select user permissions (by additionally implementing Filez Docs Platform APIs) - Supports comment notifications (by additionally implementing Filez Docs Platform APIs) |
| File lock | File editing state notifications: notify when editing starts (no one → someone) and when all users exit editing (someone → all exit). No automatic expiration (renewal) or retry guarantees | - Lock the file for editing via Lock - Reset the lock’s automatic expiration timer to 30 minutes by reusing the lock operation (see Lock) - Unlock to allow editing |
| Restrict access to using Filez Docs Platform | Online document access can be signed based on JWT or HMAC. Generating file-open requests requires a secret key. | No restrictions |
| Restrict access to data | Requests from Filez Docs Platform can be verified based on JWT signature. Requests are signed with a secret key to ensure they cannot be executed by third parties. | Requests from Filez Docs Platform server are verified using a private key used to sign requests and the public key published in the proof-key element of the WOPI discovery XML. |