API Integration
External systems can work with Docwize through its API. An integration identifies itself with an API key. What it can do is set by the scopes of that key and by the access of the user the key belongs to.
Who this is for
Developers who connect an external system to Docwize, and the administrators who create API keys for them. This is not a Portal screen.
What an integration can do
| Area | Examples |
|---|---|
| Documents and folders | Create documents and file them in folders, upload files and new versions, read and update document fields, and download files. |
| Search and data | Search documents, and run Query Builder views and interfaces. |
| Configuration | Manage custom-field templates, record templates, document and email templates, lookup lists and reference numbers. |
| Workflows | Start a workflow on a new document, and resume a workflow that is waiting at a Webhook Node. |
What an integration needs
| An API key | A user creates the key in API Key Management and gives it the scopes the integration needs. See API Key Management. |
| The developer reference | The request and response formats are in the Docwize developer reference, which Docwize provides to integration developers. Ask the organisation's Docwize contact for it. |
Related configuration
- API Key Management — creating API keys and setting their scopes
- Access Control — the folders and documents the key's user can reach
- Webhook Node — the workflow step that waits for an external system