Moeilijkheidsgraad: expert

API staat voor Application Programming Interface en maakt eenvoudige uitwisseling van gegevens en functionaliteit mogelijk. De Workplace API documentatie (Swagger) is beschikbaar in een apart tabblad in het GO menu.

Toegang krijgen tot Workplace API

• Ga naar Workplace

• Inloggen met je gegevens

De optie verschijnt alleen voor gebruikers met een ontwikkelaars- of beheerdersrol. Zie Roles and Profiles voor meer informatie.

Open

Om de API's in je eigen projecten te gebruiken (bijvoorbeeld postman), is het misschien interessant om de swagger.json-link te gebruiken. Zoals je in de schermafbeelding kunt zien, wordt de "nieuwste" pagina standaard geopend, maar dit kan natuurlijk veranderen.

Het gebruik van een specifieke versie heeft het voordeel dat je in de toekomst API-versies kunt vergelijken.

Open

De API testen: voorbeelden

Het is mogelijk om de Workplace API uit te proberen/te testen. Afhankelijk van het verzoek moet je misschien eerst wat informatie invullen.

In de onderstaande voorbeelden wordt "locatie-ID" genoemd. Een locatie selecteren op Workplace wordt de referentie weergegeven, bijvoorbeeld "Vergaderzaal 1". Maar in de back-end van Workplace heeft elke locatie een unieke locatie-ID.

Bijvoorbeeld de Locatie ID voor verdieping "2e verdieping" in Spacewell Antwerpen is "910000000004545".

Voorbeeld 3. Reserveringen

Om de reserveringen uit je omgeving op te halen, kun je Reservations API > "een lijst met reserveringen ophalen" gebruiken.
Wijzig de datums in de zoekinstructie om (gefilterde) reserveringen te krijgen, elk met de locatie-ID, om zo aan te geven welke locatie is geboekt.
Voer locatie-id's in het zoekfilter in om gefilterde gegevens te krijgen.

Concrete use case: URL om live plattegrond te tonen

Stel je voor dat je een URL naar je kioskschermen wilt pushen om Workplace live plattegrondgegevens te visualiseren.

Hier stellen we voor om een toegangstoken met een URL te geven, Zodat iedereen met de link de live plattegrond kan zien.

Alternatieve methoden en veelgestelde vragen hierover vind je hier: Workplace live floorplan data visualization

De hieronder voorgestelde speciale methode omvat webauthenticatie via Rest API. Dit betekent dat een Workplace login + wachtwoord nodig zijn, en de API zal een JWT token teruggeven dat kan worden gebruikt om toegang te krijgen tot alle andere API-aanroepen. Voor een autorisatie-gerelateerde actie hebben we de COBUNDU Authorization service. Deze heeft een openbare Swagger UI (en swagger.json-link) beschikbaar op https://login.cobundu.com/rest/v2/docs. Je kunt de API gebruiken via Swagger UI of Postman, of een andere tool naar keuze. Dit voorbeeld is gebaseerd op onze Swagger UI.

Vereisten

• Webkiosk moet worden geconfigureerd in Studio

• Per verdieping waarvoor je visualisatie wilt instellen, is een Workplace gebruiker nodig:

  • Minimale rechten op de Workplace/geen specifieke rol nodig

  • rekening houdend met reserveringsfuncties die zijn ingesteld voor deze omgeving

  • Gebruikersnaam + wachtwoord

• Om toegang te krijgen tot API: Workplace gebruiker met een Admin of Developer rol

Oplossing

1. API gebruiken om sessietoken te krijgen

   1. Ga naar https://login.cobundu.com/rest/v2/docs (gebruiker moet de rol Admin of Developer hebben)

      1. Selecteer "auth" > /auth/ssosettings/{loginId} (retourneer sso-instellingen voor de gebruiker)

      2. Geef gebruikersnaam

      3. De respons geeft de hostnaam van de COBUNDU Auth-instantie die moet worden gebruikt (Workplace IoT Platform is beschikbaar voor de EU en de VS) (kan bijvoorbeeld "apiUrl" zijn: https://login.eu1.cloud.cobundu.com)
         
         

   2. Navigeer naar de apiUrl + /rest/v2/docs van de vorige stap dat is https://login.eu1.cloud.cobundu.com/rest/v2/docs is dit voorbeeld (gebruiker moet de rol Admin of Developer hebben)

      1. Selecteer "auth" > /auth/login (gebruiker authenticeren)

      2. Geef de gebruikersnaam + het wachtwoord op dat wordt gebruikt om toegang te krijgen tot live gegevens

      3. Wijzig de aanmeldparameter "rememberme": true

      4. Het restveld kan worden verwijderd. Voorbeeld (probeer geen komma aan het einde van de wachtwoordregel te laten staan):

      5. De respons bevat accessToken
         
         

      6. Toegangstoken is klaar voor gebruik

2. URL voor webkiosk voorbereiden

   1. Ga naar http://go.cobundu.com (gebruiker heeft de rol van beheerder of ontwikkelaar nodig) > Kioskmodus

   2. Selecteer de relevante verdieping > open webkiosk

   3. Web Kiosk URL heeft het volgende formaat https://go.cobundu.com/kiosk/MEETING%7C1d18e8b0-48a7-464c-8813-66608b474d6d

   4. Navigeer in een browser naar https://go.cobundu.com/rest/serverinfo of in Postbode een verzoek indienen bij https://go.cobundu.com/rest/serverinfo?jwt= en kopieer/plak accessToken aan het einde van de URL
      
      

   5. De apiUrl bevat een correct cloud-eindpunt voor uw account (EU of VS). Vervang go.cobundu.com in je Web Kiosk URL met deze regio apiUrl, krijg je bijv. https://go.eu1.cloud.cobundu.com/kiosk/MEETING ...

   6. Voeg achtervoegsel "?jwt=" toe en kopieer/plak accessToken aan het einde van de URL

3. Toegang tot deze URL (bijvoorbeeld in incognitomodus) en de webkiosk zal openen op de gekozen verdieping zonder om identificatie te vragen. Elke 10 minuten wordt een sessie vernieuwd binnen de toepassing.

   1. Nadat de token is verkregen, heb je 10 minuten om deze door te geven in de URL om de plattegrond te openen.

   2. Nadat de plattegrond is geladen, wordt het vernieuwen van de token automatisch uitgevoerd zonder sessieverlies of handmatige tussenkomst.

       

Beperkingen

• Webkiosk toont reserveringsweergave (= gecombineerde bezettingsgraad- en reserveringsgegevens (indien beschikbaar))

• Als browser crasht/computer is losgekoppeld: herstart het proces om een nieuw toegangstoken te krijgen

Zoek op