Skip to main content

Frontend Integration Mode

To integrate with Filez Document Platform, third parties need to provide the following four types of information:

  1. Information about the user currently editing or previewing
  2. Metadata of the document the current user is operating
  3. URL address for downloading the document
  4. URL address for saving the document after editing

Based on how third parties provide the above four types of information, there are two integration modes. Third parties can choose either one to implement:

  • Active Integration. When third parties call Filez Document Platform interfaces for editing/previewing, they actively pass the above four types of information through request parameters. With this integration method, third parties can flexibly define document download addresses and save addresses.
  • Passive Integration. Third parties do not pass the above four types of information when calling Filez Document Platform interfaces, but third parties need to implement 4 interfaces according to Filez Document Platform's standard integration method (for detailed interface information, please read "Filez Document Platform - Integration Edition Third-Party Standard Integration Interface Documentation"). For example, when the third-party service address is http://3rd-party/api/zOffice, the interfaces for obtaining the above four types of information are respectively:
    GET http://3rd-party/api/zOffice/profiles
    GET http://3rd-party/api/zOffice/${docId}/meta
    GET http://3rd-party/api/zOffice/${docId}/content
    POST http://3rd-party/api/zOffice/${docId}/content

Frontend Integration Request Address

GET http(s)://${zOffice-server-IP}:${zOffice-server-port}/docs/app/driver-callback