DocuFlow API - Introductie
- Jeffrey Rijdes
De DocuFlow API is te gebruiken vanaf DocuFlow versie 6.1.60 (releasedatum 19 januari 2024).
Structuur van de API
De DocuFlow API is gebaseerd op veelgebruikte standaarden en protocollen. Met elke HTTP-client, in elke programmeertaal, kan je communiceren met de DocuFlow API.
Elke opdracht naar de DocuFlow REST API is een verzoek over het HTTP protocol. Door een verzoek te doen naar een URL met daarin een bepaalde endpoint en HTTP-methode geef je aan wat voor opdracht er moet worden uitgevoerd. De HTTP-methodes die worden ondersteunt zijn:
GET: haal gegevens op
POST: voeg gegevens toe
Bij elk HTTP-verzoek die je doet dien je authenticatie mee te geven in de aanvraag. Meer informatie over het authentiseren lees je hier: DocuFlow API - Authenticatie.
Documentatie
In deze kennisbank lees je informatie over hoe je de DocuFlow API kan gebruiken en toelichting op termen en mogelijkheden. De technische API documentatie kan je hier vinden: https://documizers.platform.documizers.com/DocuFlow/api-docs/index.html .
Terminologie
API term | Nederlands | Engels | Uitleg | |
|---|---|---|---|---|
| 1 | WorkspaceItem | Opdracht | Workspace item of Job | Een unieke opdracht binnen een proces |
| 2 | Process | Proces | Process | Een proces binnen DocuFlow |
| 3 | ProcessName | Proces naam | Process name | De naam van het proces |
| 4 | Step | Stap | Step | Een stap binnen een proces, die stap bevat de daadwerkelijke configuratie van wat er moet gebeuren. We kennen we soorten stappen:
|
Â