Werkbon App - OpenAPI Documentation

Open API

Open API functionaliteiten

Voor WerkbonApp is er een Open API ontwikkeld. Voor alle communicatie met de API is verificatie verplicht. Verificatie werkt door middel van aangemaakte tokens.

De Token dient bij elk request naar de API meegestuurd te worden, de authenticatie werkt dus niet door middel van een sessie.

API base URL
http://www.werkbonapp.nl/openapi/<versie>/<function>/?token=<token>

Om toegang te hebben tot de API dien je de URL parameter “token” mee te geven. Ook bij een POST of UPDATE request gaat het hier om een URL parameter. Wanneer de “token” ontbreekt of niet correct is zal de API “unauthorized” als resultaat geven. In de API is ook een versie nummer opgenomen. Bij nieuwe varianten wordt dit nummer steeds met 1 opgehoogd.

Network diagram

Verkrijgen van de token

Ga naar www.werkbonapp.nl en log in met je credentials. Ga in je persoonlijk account naar het tabje Start.
Naast het kopje ERP/CRM klik je op de link Overzicht.

Network diagram

Kies nu uw software-pakket en klik daarna op Opslaan. Indien uw software-pakket er (nog) niet tussenstaat kies dan voor BouwOffice. Nadat u op Opslaan hebt gedrukt wordt de token zichtbaar. Deze is gelinked aan het account waar op ingelogd is en zal niet meer wijzigen.

Als er medewerkers gepost worden (PostEmployees), worden deze ook zichtbaar in dit scherm.

Network diagram

Status diagram werkbon op web-portaal

Een werkbon heeft een specifieke status. De status wijzigt aan de hand van de levenscyclus van de werkbon. Aan de status kan afgelezen worden waar de bon zich in het proces bevindt. Voor de externe koppeling is het belangrijk om te weten dat bonnen met de status ‘Compleet’ automatisch wijzigen in ‘Afgehandeld’ als de bon via de Open API wordt opgehaald. Zodoende wordt de bon bij de volgende aanvraag niet nog een keer opgehaald. Onderstaand schema laat de verschillende statussen zien.

Network diagram

API versies

Kijk hier voor het overzicht van de versies.