REST API: testen en probleemoplossing – Helpcentrum

Moeilijkheidsgraad: expert

Inhoud

Testvoorbeelden
URL voor liveplattegrond
Probleemoplossing

Leerdoelen

Na het lezen van dit artikel kun je:

Workplace-API’s testen

Testvoorbeelden

Je kunt API’s proberen; sommige vragen extra invoer.

Voorbeeld 1. Sensorlijst

Try it out,
Execute,
voor alle tenantsensoren.

Elk kanaal, zoals vochtigheid, temperatuur en CO2, afzonderlijk geleverd.

Voorbeeld 2. Actuele locatiegegevens

Try it out,
Verplicht locatie-ID
Execute,
voor gekoppelde sensoren.

Voorbeeldcomfortsensor levert alle beschikbare temperatuur-/vochtigheidswaarden en ontvangsttijd.

Locatiekeuze op https://go.cobundu.com/ toont referentie zoals Meeting Room 1, maar backend gebruikt uniek ID.

Info

Locatie-ID staat in backend- https://studio.cobundu.com URL bij de gekozen locatie.

Voorbeeld 2nd floor Antwerpen: 910000000004545

Voorbeeld 3. Reserveringen

Reservations API > get a list of bookings.
Datums aanpassen voor gefilterde reserveringen met locatie-ID.
Locatie-ID’s als filter.

Voorbeeld 4. Locatiegegevens

Selectie op https://go.cobundu.com/ toont referentie, backend uniek ID.

Locations API levert deze informatie.
Volgens behoefte:

Alle clientlocaties
Get location tree, bijvoorbeeld filter workplace voor werkplekken

Voorbeeld 5. Plattegrond

Locations > get a location's drawing as SVG
Gebruik verdieping-ID.
Swagger geeft antwoord maar toont geen SVG.

Voer verdieping-ID in deze URL in: https://go.eu1.cloud.cobundu.com/rest/v3/locations/verdiepingslocatie-ID/drawing/svg

Voorbeeld 6. Sensorwaarden

Zie REST API - GET Sensor Values

URL voor liveplattegrond

Een URL naar kioskschermen voor livegegevens.

Hier access token in URL zodat linkhouders de plattegrond zien.

Alternatieven en vragen: Workplace-liveplattegrondgegevens tonen

Deze methode gebruikt REST-authenticatie met Workplace-gebruikersnaam/wachtwoord. Retourneert JWT voor andere API-aanroepen. COBUNDU Authorization heeft openbare Swagger-interface en swagger.json op https://login.cobundu.com/rest/v2/docs. Gebruik Swagger, Postman of andere tool; voorbeeld gebruikt Swagger.

Opmerking

Nieuwste auth-methodeversie gebruiken; status september 2024 v2, zie https://login.cobundu.com/rest/v2/docs)

Vereisten

Webkiosk in Studio geconfigureerd
Per verdieping een gebruiker:
- Minimale Workplace-rechten, geen specifieke rol
- Volgens reserveringsfuncties
- Gebruikersnaam en wachtwoord
API-toegang met Admin of Developer

Oplossing

Sessietoken ophalen
1. Ga naar https://login.cobundu.com/rest/v2/docs Admin/Developer vereist
  1. Auth > /auth/ssosettings/{loginId}
  2. Gebruikersnaam
  3. Body geeft juiste EU-/VS-authhost, bijvoorbeeld apiUrl: https://login.eu1.cloud.cobundu.com)
2. Open apiUrl + /rest/v2/docs uit vorige stap, namelijk https://login.eu1.cloud.cobundu.com/rest/v2/docs in dit voorbeeld; Admin/Developer vereist
  1. Auth > /auth/login
  2. Gebruikersnaam/wachtwoord voor livegegevens
  3. rememberme: true
  4. Overige velden verwijderen; geen afsluitende komma na wachtwoordregel
  5. Body geeft accessToken
  6. Token gereed
Webkiosk-URL
1. Ga naar http://go.cobundu.com Admin/Developer > Kiosk Mode
2. Verdieping > webkiosk
3. URL-formaat: https://go.cobundu.com/kiosk/MEETING%7C1d18e8b0-48a7-464c-8813-66608b474d6d
4. Browser openen op https://go.cobundu.com/rest/serverinfo of Postman-aanvraag naar https://go.cobundu.com/rest/serverinfo?jwt= en accessToken achteraan plakken
5. apiUrl is correcte EU-/VS-cloud. Vervang go.cobundu.com in kiosk-URL door die regiohost, bijvoorbeeld https://go.eu1.cloud.cobundu.com/kiosk/MEETING| ...
6. Voeg ?jwt= met accessToken toe
Open deze URL bijvoorbeeld incognito: verdieping zonder verdere identificatie. Sessie elke tien minuten vernieuwd.
1. Na verkrijgen token binnen tien minuten openen.
2. Daarna automatische vernieuwing zonder sessieverlies of handwerk.