HANDLEIDING
Formulieren Management Systeem: www.formdesk.nl
 
 
 

Webservice API - Formdesk programmatisch aansturen
 
Naast het ‘handmatig bedienen’ van Formdesk via de website biedt Formdesk een 2e mogelijkheid aan: de webservice.

Deze handleiding beschrijft wat een webservice is en wat u ermee kunt doen. Hoe u met de webservice kunt communiceren en welke functies worden ondersteund wordt uitgelegd in de technische handleiding voor ontwikkelaars.

De Formdesk webservice, ook wel API genoemd (Application Programming Interface) maakt het voor een computerprogramma mogelijk met Formdesk te communiceren via een standaard protocol.

Bekijk de technische handleiding in Postman voor ontwikkelaars.

Door gebruik te maken van de webservice kunt u veel voorkomende handelingen verregaand automatiseren of Formdesk beter integreren in uw (geautomatiseerde) bedrijfsprocessen. U kunt bijvoorbeeld uw boekhouding, orderverwerkingssysteem, documentverwerkingsysteem etc. laten communiceren met Formdesk. In combinatie met de Formdesk webhook biedt de webservice krachtige integrale koppelingsmogelijkheden. In veel gevallen zult u een (bescheiden) applicatie moeten laten ontwikkelen die de communicatie verzorgt tussen uw systeem en Formdesk. Dit stukje programmatuur, de connector, kan een zelfstandige applicatie zijn maar zou ook in uw bestaande systeem ontwikkeld kunnen worden.

Voor het gebruik van de webservice heeft u API credits nodig. Bekijk het hoofdstuk ‘Kosten en uitproberen’ voor meer informatie hierover.
 
Algemene informatie over API - Geautomatiseerd koppelen
 

Kosten en uitproberen
Voor het gebruik van de webservice kunt u API-credits kopen. Voor bijna alle functies geldt dat ze bij gebruik 1 credit kosten. Sommige functies kosten geen credits en andere functies kosten credits naar gelang de hoeveelheid informatie die de functie teruggeeft. De technische handleiding vermeldt bij iedere functie hoeveel credits deze verbruikt.

Iedere functie geeft terug hoeveel API-credits er nog over zijn. De connector kan daarmee controleren of het saldo aan credits nog voldoende is. Daarnaast wordt u, net als bij het bereiken van de abonnementslimieten, per e-mail gewaarschuwd als de API-credits bijna op zijn.

Heeft u een standaard abonnement en de API-credits zijn verbruikt dan kunt u de webservice niet meer gebruiken. Bij een zakelijke abonnement blijft de webservice wel functioneren.

Om de webservice te kunnen uitproberen krijgt u 100 API-credits.

API-credits kosten 50 euro per 5.000 credits. Probeert u uw applicatie dan ook zo efficient mogelijk te programmeren zonder onnodige api aanroepingen.
 

Rechten & Beveiliging
De communicatie van gegevens kan over een beveiligde verbinding plaats vinden (SSL). Ook de connector moet, net als u, inloggen in Formdesk. Dit gaat niet met uw gebruikersnaam en wachtwoord maar met een speciale sleutel, de API-key. Deze sleutel vindt u in uw Formdesk supervisor account op de pagina 'account-gegevens' en bij de gebruiker in gebruikersbeheer. De API-key zal de rechten van de bijbehorende gebruiker respecteren. Indien u dus de rechten van de API toegang wilt beperken dan kunt u een gebruiker aanmaken met die rechten en de bijbehorende API-key gebruiken.