INHOUDSOPGAVE


Ondersteuning


Wanneer er problemen zijn met API's dan kunnen wij hier beperkte ondersteuning op bieden. Wij bieden de mogelijkheid om gebruik te maken van onze API's en hebben getest dat de functies welke wij aanbieden werken. Wanneer er vanuit jullie code ander gedrag zichtbaar is dan dat jullie verwachten, dan willen wij eerst vragen het te verifiëren via Swagger.


Swagger


Dit kan door naar onze Swagger pagina te gaan op https://api01.xpertsuite.app/ (productie) en https://api01.accxpertsuite.app/ (acceptatie)


Wanneer je dan de pagina benadert van de API welke je wilt gebruiken, in onderstaand voorbeeld de Workflows pagina. Dan heb je de mogelijkheid om via de groene knop 'Authorize' verbinding te maken.



Er wordt gevraagd om de Bearer token op te voeren in het format beschreven. Deze JWT token heb je zelf beschikbaar wanneer je een sessie start via de API. Het resultaat zou iets moeten zijn in de vorm van 'Bearer xxxxx.yyyyy.zzzzz', vergeet de spatie niet.



Daarna kan je via de knop 'Try it out' de API testen.



Voer de gewenste waardes in en druk op de grote blauwe knop execute.



In dit geval zou er een taak in een traject moeten verschijnen. Mocht dat niet zo zijn dan zie je mogelijk een response met een foutmelding. Wanneer een API niet werkt, ook wanneer er naar jullie idee via Swagger juiste waardes gebruikt zijn, dan kan er contact opgenomen worden met de Xpert Desk. Wanneer het via de Swagger pagina werkt maar via jullie eigen code niet dan kan de Xpert Desk daar geen ondersteuning op bieden. Er zitten dan naar alle waarschijnlijkheid fouten in de code waarmee de API benaderd wordt.


Logging

Wij hebben geen logging van requests en responses vanuit onze API. Er wordt van onze klanten verwacht dat wanneer ze programmatuur bouwen om de API te gebruiken, dat zij zelf deze logging aanmaken om te monitoren en foutonderzoek te kunnen doen.


Testen API

Wij raden altijd aan om eerst via een acceptatie omgeving de API te testen, voordat er op productie verder gegaan wordt. Dit om te voorkomen dat er mogelijk verkeerde dingen op productie uitgevoerd worden. Er zijn gevallen bekend dat er grote hoeveelheden data doorgezet zijn via de API waar dat eigenlijk niet de bedoeling was. Herstelwerkzaamheden welke daardoor ontstaan moeten daar dan tegen SDE's uitgevoerd worden.


Wat betekent de afkorting SDE?


Vragen


Mochten er verder vragen zijn over de API en de mogelijkheden daarvan dan kan er altijd contact opgenomen worden met de Xpert Desk. Wij kunnen de juiste personen binnen de organisatie benaderen om hier in te ondersteunen en te adviseren.