Ook bij workspace is het mogenlijk gebruik te maken van de Restful API voor gebruik binnen
applicaties.
Het is een Restful API en zal gebruikt moeten worden middels het HTTP protecol. Het HTTP protocol is
makkelijk te gebruiken en is bekend bij alle ontwikkelaars. De API verwacht dat de ontwikkelaar gebruik
weet te maken van het HTTP protocol. HTTP aanvragen zoals OPTIONS, GET, PUT, POST en DELETE zijn de
voornaamste requests die gedaan kunnen worden. Authenticatie processen zullen plaats vinden via HTTP
Basic Auth.
HTTP Basic Auth is goed te gebruiken vanuit script en programmeertalen en is ondersteund binnen de
command line. De ondersteunde response bestand types zijn json en xml.
De resources binnen de API bestaan uit collecties en elementen. Een collectie bestaat uit meerdere elementen.
| # | OPTIONS | GET | POST | DELETE |
|---|---|---|---|---|
Collectie https://api.workspace.nl/v1/gebruikers |
Geeft aan welke HTTP aanvragen mogelijk zijn. | Geeft een resultaat van alle gebruikers terug. | Kan worden gebruikt om een nieuwe gebruiker aan te maken. | Kan worden gebruikt om alle gebruikers te verwijderen. |
Element https://api.workspace.nl/v1/gebruikers/123 |
Geeft aan welke HTTP aanvragen mogelijk zijn | Geeft 1 gebruiker terug. | Kan worden gebruikt om een gebruiker aan te passen. | Kan worden gebruikt om een gebruiker te verwijderen. |