Rest API
De Grub REST API maakt het mogelijk om Grub te koppelen aan externe systemen, zoals eigen applicaties of interne tools. Via de API kunnen gegevens veilig worden opgehaald en verwerkt, zodat handmatige acties worden verminderd en processen geautomatiseerd kunnen worden. De API is bedoeld voor technische gebruikers en developers die Grub willen integreren binnen hun eigen IT-landschap.
In dit artikel lees je:
Wat is de Grub REST API?
De Grub REST API is een externe interface waarmee gestructureerde gegevens uit Grub kunnen worden opgevraagd via HTTP-verzoeken. De API werkt volgens REST-principes en gebruikt JSON als dataformaat.
Met de API kun je onder andere:
-
Gegevens uitlezen vanuit Grub
-
Integraties bouwen met andere systemen
-
Processen automatiseren die normaal handmatig verlopen
De API is alleen toegankelijk voor geautoriseerde gebruikers.
Bij het ophalen van gegevens via de Grub REST API is een unieke identificatie (Unique ID) vereist voor zowel Bedrijfsdossiers als Personendossiers. Deze Unique ID fungeert als de primaire sleutel binnen Grub en zorgt ervoor dat altijd het juiste dossier wordt opgehaald.
Wanneer je via de API een dossier wilt ophalen, moet je daarom altijd de bijbehorende Unique ID van het betreffende Bedrijfsdossier of Personendossier meegeven in het verzoek. Zonder deze Unique ID kan de API het dossier niet eenduidig identificeren en zal het verzoek niet succesvol worden uitgevoerd.
De Unique ID wordt gegenereerd binnen Grub en kan bijvoorbeeld via eerdere API-responses of interne referenties uit je integratie worden verkregen. Het is daarom belangrijk dat deze ID in externe systemen wordt opgeslagen wanneer je later opnieuw gegevens uit hetzelfde dossier wilt ophalen.
Hoe krijg je toegang tot de API?
Om gebruik te kunnen maken van de Grub REST API zijn de volgende stappen nodig:
-
Stuur een e-mail naar je contactpersoon of grubsupport@compliance-wise.com om API-toegang aan te vragen.
-
Na het mailen ontvang je vanuit het Grub team de benodigde authenticatiegegevens om API-verzoeken te kunnen doen.
-
Gebruik deze gegevens in je eigen applicatie of integratie om verbinding te maken met de Grub API.
Zonder geldige authenticatie is het niet mogelijk om verzoeken naar de API te versturen.
Waar vind je de technische documentatie?
De volledige technische documentatie van de Grub REST API is online beschikbaar. Hierin vind je onder andere:
-
Beschikbare endpoints
-
Request- en response-voorbeelden
-
Authenticatiemethoden
-
Technische specificaties
De documentatie is te vinden via de volgende pagina:
https://login.grubvooraccountants.nl/grub-external-api/index.html
Deze documentatie is met name bedoeld voor developers en technische partners die zelfstandig met de API aan de slag gaan.
Neem contact op
Heb je vragen over de Grub REST API of twijfel je of deze geschikt is voor jouw use-case?
Neem dan contact op met onze supportafdeling voordat je met de implementatie start. Zo voorkomen we onnodige vertraging of foutieve implementaties.