Győződjön meg arról, hogy rendelkezik API-kulccsal, és hogy beszerzett egy tokent az OAuth 2.0 engedélyezési típusú kliens hitelesítő adatok használatával. (További információkért lásd az Első lépések útmutatót ).
Az épületek listájának lekérése a v1/public/buildings végpont használatával.

például

GET <https://api.onkadence.co/v1/public/buildings

>

{ "@context": "/v1/contexts/Building", "@id": "/v1/public/buildings", "@type": "hydra:Collection", "hydra:totalItems": 1, "hydra:member": [ { "@id": "/v1/public/buildings/01EMPPAER4FWYN1MSBW0NAZSBK", "@type": "Building", "id": "01EMPPAER4FWYN1MSBW0NAZSBK", "name": "Bell Yard Coffee - Bell Yard", "timeZone": "Europe/London", "latitude": "51.51459200", "longitude": "-0.11192900", "addressLine1": "1 Quality Court", "addressLine2": "Holborn", "city": "London", "county": "Greater London", "countryCode": "GB", "createdAt": "2023-06-29T08:40:31+00:00", "modifiedAt": "2023-07-07T10:27:00+00:00", "countryName": "United Kingdom" } ], "hydra:view": { "@id": "/v1/public/buildings?countryCode=GB&city=London&name=Bell%20Yard", "@type": "hydra:PartialCollectionView" }, "hydra:search": { "@type": "hydra:IriTemplate", "hydra:template": "/v1/public/buildings{?}", "hydra:variableRepresentation": "BasicRepresentation", "hydra:mapping": [] } }

Minden épület esetében a v1/public/floors végpont használatával kérd le az emeletek számát. Ez az API támogatja a buildingId lekérdezési paraméter használatával történő szűrést.

például

GET <https://api.onkadence.co/v1/public/floors?buildingId=01EMPPAER4FWYN1MSBW0NAZSBK

>

{ "@context": "/v1/contexts/Floor", "@id": "/v1/public/floors", "@type": "hydra:Collection", "hydra:totalItems": 2, "hydra:member": [ { "@id": "/v1/public/floors/01F01JHXDZCKNP4J9N9PA878Q1", "@type": "Floor", "id": "01F01JHXDZCKNP4J9N9PA878Q1", "name": "Floor 1", "floorplanUrl": "<https://static.onkadence.co/a/floorplan.svg>" }, { "@id": "/v1/public/floors/01FXSN478SSJAEEWJ26F9MHK4W", "@type": "Floor", "id": "01FXSN478SSJAEEWJ26F9MHK4W", "name": "Floor 2", "floorplanUrl": "<https://static.onkadence.co/another/floorplan.svg>" } ], "hydra:view": { "@id": "/v1/public/floors?buildingId=01EMPPAER4FWYN1MSBW0NAZSBK", "@type": "hydra:PartialCollectionView" } }

Töltse be az SVG-t az floorplanUrl . Az emeleten található minden egyes helyiség SVG elemként van ábrázolva, amelynek azonosítója a következő formátumban van:

space::{space_type}::{spaceId}
Egy adott emelet foglalásának lekérése a v1/public/bookings végpont használatával. Emeletazonosító és dátumtartomány szerint szűrhet, hogy egy adott napra vagy időszakra vonatkozó foglalásokat kapjon.
például

GET <https://api.onkadence.co/v1/public/bookings?floorId=01F01JHXDZCKNP4J9N9PA878Q1&order[startDateTime]=asc&startDateTime[local_after]=2023-01-01T00:00:00Z&startDateTime[local_before]=2023-01-01T23:59:59Z

>

{ "hydra:member": [ { ... "id": "01GTBV1CT3BM8A42SEJ2J5F4EG", "startDate": "2023-01-01T09:00:00+00:00", "endDate": "2023-01-01T17:00:00+00:00", "status": "booked", "type": "desk", "building": "/v1/public/buildings/01EMPPAER4FWYN1MSBW0NAZSBK" } ], "hydra:totalItems": 1 }
Rendelje hozzá az egyes foglalási eredményekből származó spaceId-t a megfelelő SVG elemhez a fent említett azonosítóformátum használatával. Ezután a foglalási állapot alapján formázhatja az SVG elemet. Például:

kitöltés: #60D27B (zöld) elérhető
kitöltése: #FF9B53 (narancssárga) a foglaltakhoz

Az alaprajz naprakészen tartása érdekében rendszeresen (pl. 5 percenként) kérdezze le a foglalási végpontot, hogy az tükrözze a valós idejű elérhetőségi változásokat.

Egy működő példáért és a teljes forráskódért látogassa meg a mintaalkalmazás GitHub repository-nkat .

Áttekintés