Basic Concepts
Files, Users, and Permissions
Files: Files are stored in the business system, and each file must have a file ID. The naming rules for IDs are determined by the business system, requiring that the same file has the same ID, and different files have different IDs (except for file systems that support multiple versions). When the business system calls online editing/preview, it needs to provide the file ID. Filez Document Platform will call back to the business system based on the file ID to obtain the corresponding file.
Users: Filez Document Platform does not need to synchronize the organization and users of the business system. During online editing and online preview, the caller (business system) needs to provide current user information. This user information will be recorded in the document platform and reflected in the files, such as: revision records, comments, and collaboration records.
Permissions: Only the business system knows whether a user can edit/preview a file online at a certain moment. This information does not need to be synchronized to the document platform. Every time the document platform provides online editing/preview services, it will ask the business system whether the current user has permission.
Important Terms
Document ID (docId)
That is, docId. Every file in a third-party system must have a unique document ID. The same file has the same ID. When a third-party system requests online editing/preview services, it needs to specify the docId for editing/previewing.
Business System ID (appId/repoId)
Filez Document Platform can support online preview/editing of files from multiple business systems. Each business system needs to register a unique appId in the platform. When a third-party system requests online editing/preview services, it needs to provide the appId for the current request.
Third-Party Business System Callback Context
Third-party business systems need to implement callback APIs on the server side. The context (service endpoint) of the callback address needs to be configured in the Filez Document Platform, and at least the business system callback host needs to be configured.