This document provides a high-level overview of the Filer external API, outlining its key endpoints and their respective usage. The Filer API powers various applications, both internal and external, as detailed below:
Internal Applications Supported by the Filer API:
- Admin Blazor SPA Application: Accessed via /api/admin/, providing backend services for the Blazor Single Page Application.
- Filer SPFx React App: Accessed via /api/spfx/, designed for SharePoint Framework (SPFx) functionality.
- Filer Triage SPFx React App: Accessed via /api/triage/ designed for SharePoint Framework (SPFx) functionality.
- Outlook Add-in React App: Accessed via /api/outlook/, providing integrations for the Outlook add-in.
External Applications:
External API Access: Exposed at /api/external/, allowing external vendors to interact with the Filer database using an API key for secure access.
Focus of This Document:
The primary focus of this document is to provide a summary of the external API usage, enabling external stakeholders to integrate with Filer's data services.
Additional API Reference:
For comprehensive API definitions and details, you can refer to the Swagger documentation available for each Filer instance. The Swagger documentation can be accessed at the following URL format:
- [Your api Uri]/swagger/
This document serves as a starting point for understanding the Filer API’s capabilities and how to leverage its external endpoints. For further details or specific implementation guidance, please consult the Swagger documentation or contact the support team.
This is the first draft. As features evolve this document will be updated.
External Api Authentication
To correctly authenticate the following headers will need to be set:
- Content-Type: application/json
- X-ApiKey: [your api key]
The provision of the organisation Filer Api key is held in the File database.
Document Routing
Record Context
Operational