Moeilijkheidsgraad: expert
Inhoud
Leerdoelen
Na het lezen van dit artikel kun je:
- API-mogelijkheden begrijpen
- Workplace-API’s testen
Application Programming Interface wisselt gegevens en functies uit. Swagger-documentatie staat op een apart GO-tabblad.
Workplace API openen
- Ga naar https://go.cobundu.com/
- Log in
API-menu alleen bij Developer of Admin; zie Rollen en profielen voor uitleg.
Gebruiken
Serveroplossing
Een browser is geschikt voor kennismaken via GO, niet voor integratie naar een externe database. Gebruik een serveroplossing.
Een beveiligde backend:
- Omzeilt browser-CORS-beperkingen.
- Geeft meer controle over gegevens en authenticatie.
- Beperkt beveiligingsrisico’s.
- Verbetert prestaties en schaalbaarheid.
Spacewell staat als SaaS-provider geen cross-origin browserembedding met externe domeinen toe. Voor sensorgegevens naar databases: serveroplossing aanbevolen.
Genummerde versies
In projecten zoals Postman kun je swagger.json gebruiken. Standaard latest kan wijzigen.
Opmerking
Gebruik genummerde versies, bijvoorbeeld https://go.cobundu.com/rest/v3/docs, om conflicten te voorkomen.
Een vaste versie maakt latere vergelijking mogelijk.
Opmerking
Kies per API-methode de nieuwste versie
Status september 2024
- GO API: v3 is de nieuwste; zie https://go.cobundu.com/rest/v3/docs
- auth-based API: v2 is de nieuwste; zie https://login.cobundu.com/rest/v2/docs
Serverantwoord begrijpen
Try It Out controleert parameters; 200 met waarden bevestigt correcte invoer.
Alleen 200 is onvoldoende; er kan nog een probleem zijn:
Code 200, lege body []
Bijvoorbeeld From date in de toekomst geeft lege body
Request URL controleren
Plak Request URL in de browser om te testen; alleen voor GET-methoden.
Info
Gebruik dezelfde browser met actieve Workplace-sessie.
Postman moet exact dezelfde URL als Try It Out gebruiken, inclusief juiste codering van bijvoorbeeld pipe. Zie https://en.wikipedia.org/wiki/Percent-encoding voor codering van speciale tekens.