Wijzigingen

Naar navigatie springen Naar zoeken springen
12 bytes toegevoegd ,  22 mei 2019 16:49
geen bewerkingssamenvatting
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 APIRestAPI? ===
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.
[[Bestand:Rest API autoriseren.png|miniatuur|300x300px]]
=== Hoe werkt de JOIN APIRestAPI? ===
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.
=== Troubleshooting? ===
Krijg je een foutmelding terug van de APIRestAPI: in de API staan de meestvoorkomende foutmeldingen (geen toegang bijvoorbeeld) gedocumenteerd.
[[Bestand:RestAPI foutmeldingen.png|geen|miniatuur|441x441px|
veelvoorkomende response messages
]]

Navigatiemenu