¶ JOIN Rest API
JOIN Zaak & Document beschikt over een RestAPI. Deze API stelt andere softwaretoepassingen in staat om op een laagdrempelige, veilige en moderne manier gebruik te maken van de functionaliteiten van JOIN Zaak & Document. Denk dan bijvoorbeeld aan het ophalen van gegevens en taken, het uitvoeren van zoekopdrachten (op basis van JOIN Search) en het aanmaken van zaken en documenten.
Op deze pagina vind je meer informatie over de RestAPI: hoe kun je deze bereiken, waar vind je de uitgebreide documentatie en op welke manier kan er gebruik worden gemaakt van de API.
¶ Wat is een API?
Een API is een afkorting die staat voor Application Programming Interface. Een API maakt het mogelijk om andere systemen en software een ‘ingang’ tot het systeem te bieden. Met deze ingang kunnen verschillende systemen met elkaar communiceren en gegevens uitwisselen. In dit geval JOIN Zaak & Document en andere systemen. Zo maakt bijvoorbeeld ook JOIN Mobile gebruik van de RestAPI om te communiceren met alle functionaliteit die in JOIN zit.
Om een api simpel uit te leggen, maakt men vaak de vergelijking met een stekker en een stekkerdoos. Een stekkerdoos kan je zien als het systeem of de software. De stekker kan je in dit geval zien als de API. Als de stekker in de stekkerdoos past, dan kunnen ze met elkaar communiceren. Wereldwijd zijn er echter verschillende soorten stekkerdozen, waardoor deze niet altijd in elkaar passen. De documentatie van de API vertelt op welke stekkerdozen de stekker daadwerkelijk past.
¶ Waar vind ik de JOIN RestAPI?
de API wordt standaard meegeleverd met de installatie van JOIN, of je nu in de cloud zit of niet. Achter het adres van JOIN typ je “/aspx/api”. Je wordt dan automatisch doorgeleid naar de index-pagina van de API. Wij maken gebruik van Swagger, waarmee je snel en eenvoudig door alle beschikbare operaties van de API kunt navigeren.
¶ Hoe werkt de JOIN RestAPI?
De JOIN RestAPI werkt zoals je kunt verwachten van een RestAPI. Allerlei operaties zijn mogelijk, zoals het ophalen van documenten, het aanmaken van zaken en het afhandelen van taken. Maar ook zoekopdrachten en gebruikersinformatie kan worden opgehaald.
Wanneer je naar de API navigeert (zie “waar vind ik de API?”) kom je in de indexpagina van de API terecht. Hier vind je alle beschikbare typen en operaties. Ook is er documentatie beschikbaar met duidelijke voorbeelden van hoe authenticatie werkt, hoe een zaak kan worden aangemaakt etc.
¶ Nieuw vanaf versie 2023.5 Report API
In versie 2023.5 introduceren we de mogelijkheid om ook ten behoeve van rapportage doeleinden gegevens op te vragen via de Rest API van JOIN.
Hoe werkt dit?
Allereerst dient u te beschikken over een geldige licentie “REPORTS”. Hiervoor kunt u contact opnemen met uw accountmanager.
Vervolgens heeft u de mogelijkheid om een overzicht in JOIN Admin te maken en beschikbaar te stellen aan de RestAPI door de functie “Maak beschikbaar in ReportsAPI” aan te vinken bij het overzicht.
Let op: deze functie is alleen beschikbaar bij overzichten van het type “XML”.
Vervolgens kunnen deze rapportages worden opgehaald via de RestAPI van JOIN:
Onderdeel “reports”
- genereren van overzicht (ophalen):
- Status opvragen van het overzicht (overzicht wordt gebouwd)
- Resultaat ophalen van het overzicht
¶ Wat is nog meer belangrijk om te weten?
Om als klant gebruik te kunnen maken van de RestAPI heb je een geldige licentie nodig voor iedere aansluiting die op de RestAPI wordt gerealiseerd. Voor vragen hierover kun je terecht bij de accountmanager.
Daarnaast moet er in JOIN Admin een zogenaamde systeemdefinitie worden aangemaakt. Hiermee zorgen we er tevens voor dat alleen toegestane systemen via de RestAPI JOIN mogen benaderen. Omdat de API onderdeel uitmaakt van JOIN Zaak & Document wordt uiteraard zorgvuldig aandacht besteed aan autorisatie & beveiliging.
¶ Troubleshooting?
Krijg je een foutmelding terug van de RestAPI: in de API staan de meestvoorkomende foutmeldingen (geen toegang bijvoorbeeld) gedocumenteerd.
