Documentatie

De webservice is niet alleen statisch gedocumenteerd. Er is een zogenaamde verkenner (API explorer) aanwezig waarmee de API interactief bekeken kan worden.
Er wordt geadviseerd om alleen eenvoudige verzoeken uit te proberen via dit middel. Het daadwerkelijk nabootsen van software (wat normaliter gebeurt tijdens het ontwikkelen tegen de API) kan beter plaats vinden via ontwikkeltools. Zoals een restclient of curl. Er wordt in deze handleiding van uit gegaan dat de ontwikkelaar bekend is met dergelijke hulpmiddelen.

Locatie

De API verkenner is te bereiken via https://<UWDOMEIN>/api/rest/explorer/.

In de API verkenner heeft elke hoofdmethode (GET/POST/PUT/DELETE) zijn eigen kleur. Elke entiteit, elke methode, kan uitgeklapt worden. Verdere documentatie wordt weergegeven, inclusief een mogelijkheid om de vereiste input aan de API te geven.

Via de knop Try it out, wordt de API aangeroepen van het eigen systeem.
Daarna wordt zowel de Request als de Response weergegeven.

Logica / Business rules

De explorer is werken met een daadwerkelijk systeem! Dat betekent dat de explorer zich aanpast aan het gebruikersniveau.
Zie ook het onderdeel rechten in deze handleiding.

De logische consequentie is dat in eerste instantie alleen publieke methodes en entiteiten worden weergegeven. Methodes waarvoor rechten moeten zijn opgegeven, zijn dan onzichtbaar.

Via dezelfde explorer is de gebruiker echter ook in staat om in te loggen en daarmee een andere rechtenniveau aan te nemen. Dit gebeurt via de entiteit /user.

Na de methode /user/login (en een geldig wachtwoord), verschijnen naar alle waarschijnlijkheid andere methodes.

Functionele informatie: