Gebruik maken van de API

Je kunt gebruik maken van de Docfield REST API om Docfield te integreren met andere applicaties, om zaken te automatiseren, en nog veel meer.

Docfield biedt via de API onder andere de mogelijkheid om documenten aan te maken, uit te sturen voor ondertekening, en om PDFs te genereren. Voor een compleet en actueel overzicht van alle mogelijkheden van onze API verwijzen we naar onze API documentatie.

API Key aanvragen

Om een API Key aan te vragen voor het gebruik van de API kan je de volgende stappen doorlopen:

1. Zorg dat je een Beheerder bent binnen Docfield, of vraag de Beheerder om de stappen uit te voeren.
2. Ga in Instellingen > API Instellingen.
3. Kies voor 'Nieuwe API Sleutel Toevoegen' en kies een naam voor je sleutel. Bijvoorbeeld de naam van de applicatie waar je mee wilt integreren.
4. Kopier je Client en Secret. Sla deze goed op, je kan ze niet meer herstellen als je ze kwijtraakt.

Als je een sleutel hebt, dan kan je een van de API endpoints beschreven in onze API documentatie hiermee aanspreken. Gebruik oAuth 2.0 om je te authenticeren met de API. 

Webhook instellen

Voor het opvragen van PDFs van documenten bieden wij een endpoint om PDFs aan te vragen, in combinatie met een Webhook aan. Deze Webhook roepen wij aan op een endpoint dat jij host; waar Docfield een POST verzoek zal indienen op het moment dat er een nieuwe PDF gegenereerd wordt. 

Zo stel je een Webhook in.

1. Zorg dat je een Beheerder bent binnen Docfield, of vraag de Beheerder om de stappen uit te voeren.
2. Ga in Instellingen > API Instellingen en kies de API applicatie uit waarvoor je de Webhook wilt instellen en kies in het menu (...) voor 'Webhook Configureren'.
3. Voer de url van je Webhook in. We verwachten een HTTPS url. Voer je bijvoorbeeld https://domain.com/api/docfield/pdf in, dan doet Docfield een POST request op https://domain.com/api/docfield/pdf als er een nieuwe PDF beschikbaar is.

Goed om te weten, op alle webhooks zullen wij altijd een verzoek indienen voor alle gegenereerde PDFs binnen jouw omgeving. Het maakt dus niet uit of de PDF door de gebruiker gegenereerd word in de applicatie, of dat een andere API applicatie een PDF aanvraagt, alle webhooks op jouw omgeving krijgen een melding. Zorg dat je in jouw applicatie dus filtert op welke verzoeken je wilt bewaren, en welke je niet wilt bewaren.