Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

De DocuFlow API is te gebruiken vanaf DocuFlow versie 6.1.60 (releasedatum 19 januari 2024).

Met de krachtige DocuFlow API kan je over een beveiligde verbinding opdrachten aanmaken, data versturen naar DocuFlow, een proces uitvoeren en gegenereerde documenten en/of data ontvangen van DocuFlow. Zo kun je DocuFlow integreren met andere systemen.
Voordat je processen kan uitvoeren is het belangrijk om te weten wat de structuur is van de API en hoe de API requesten en responses werken.

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.

...

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 - Authenicatie.

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:

  • Get-Step: het ophalen van gegevens

  • Proces-Step: het uitvoeren van een proces