Stellen Sie sicher, dass Sie über einen API-Schlüssel verfügen und ein Token mit dem OAuth 2.0-Berechtigungstyp für Clientanmeldeinformationen erhalten haben. (Weitere Informationen finden Sie im Handbuch „Erste Schritte“ ).
Rufen Sie die Liste der Gebäude mithilfe des Endpunkts v1/public/buildings ab.

z.B

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": [] } }

Rufen Sie für jedes Gebäude die Stockwerke mithilfe des Endpunkts v1/public/floors ab. Diese API unterstützt das Filtern mithilfe des Abfrageparameters „buildingId“.

z.B

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" } }

Laden Sie das SVG aus der floorplanUrl . Jeder Raum auf der Etage wird als SVG-Element mit einer ID im folgenden Format dargestellt:

space::{space_type}::{spaceId}
Rufen Sie Buchungen für eine bestimmte Etage mithilfe des Endpunkts v1/public/bookings ab. Sie können nach Etagen-ID und Datumsbereich filtern, um Buchungen für einen bestimmten Tag oder Zeitraum abzurufen.
z.B

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 }
Ordnen Sie die SpaceId jedes Buchungsergebnisses dem entsprechenden SVG-Element im oben angegebenen ID-Format zu. Sie können das SVG-Element dann basierend auf dem Buchungsstatus formatieren. Beispiel:

Füllung: #60D27B (grün) für verfügbar
Füllen Sie aus: #FF9B53 (orange) für gebucht

Um den Grundriss auf dem neuesten Stand zu halten, fragen Sie den Buchungsendpunkt regelmäßig ab (z. B. alle 5 Minuten), um Verfügbarkeitsänderungen in Echtzeit widerzuspiegeln.

Ein funktionierendes Beispiel und den vollständigen Quellcode finden Sie in unserem GitHub-Repository für Beispiel-Apps.

Überblick