Een HTTP-verzoek heeft bepaalde parameters nodig om een verzoek te kunnen uitvoeren. Hieronder staat beschreven hoe je dat moet inrichten om een verzoek uit te voeren met de DocuFlow API.
| Anchor | ||||
|---|---|---|---|---|
|
...
Uitleg | Voorbeeld | |||
|---|---|---|---|---|
HTTP Methode | De methode die je wilt uitvoeren voor dit verzoek. Dit kan een POST of GET methode zijn. | POST | ||
Base URL | het eerste deel van de URL waar je een verzoek naar toe doet is je DocuFlow URL. Deze URL is ook te vinden bij de DocuFlow Settings → Settings → Environment Settings → DocuFlow URL. | https://documizersdemo.platform.documizers.com/DocuFlow | ||
Endpoint | de operatie uit de DocuFlow API die je wilt uitvoeren. Een overzicht van alle endpoints kan je hier vinden: DocuFlow API - Endpoints . | /api/1.0/WorkspaceItems | ||
Headers | In de header moet je de API Key meegeven, dat wordt hier uitgelegd: DocuFlow API - Authenicatie . | ApiKey: 6031086841ef43c0bdsa123fdsag | ||
Parameters | Sommige GET endpoints verwachten ook een bepaalde parameter, dit wordt beschreven in de documentatie van een bepaalde endpoint. | ?workspaceItemId=123&returnAllTags=true | ||
Request body | Bij een POST endpoint moet je de request body vullen met gegevens van de opdracht, dit kan zijn in het formaat form-data of als JSON. Dit wordt beschreven in de documentatie van de endpoint. |
|
...
Na het uitvoeren van een HTTP-verzoek krijg je een response code met het resultaat van het verzoek. Naast de response code krijg je ook een bericht in de body terug met daarin het resultaat van het verzoek of een foutmelding indien er iets fout is gegaan.
Response code
Uitleg
200
Success: Succesvol uitgevoerd
201
Created: het POST verzoek is succesvol aangemaakt
204
No content: er is geen request body meegegeven in het verzoek
400
Bad request: er is een foutmelding opgetreden
401
Unauthorized: niet gemachtigd om met de ApiKey dit verzoek uit te voeren
404