Gwnewch yn siŵr bod gennych allwedd API a'ch bod wedi cael tocyn gan ddefnyddio'r math grant OAuth 2.0 ar gyfer manylion mewngofnodi'r cleient. (Gweler y Canllaw Dechrau Arni am ragor o wybodaeth).
Adalw'r rhestr o adeiladau gan ddefnyddio'r pwynt terfyn v1/public/buildings .

e.e.

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

Ar gyfer pob adeilad, adferwch ei loriau gan ddefnyddio'r pwynt terfyn v1/public/floors . Mae'r API hwn yn cefnogi hidlo gan ddefnyddio'r paramedr ymholiad buildingId.

e.e.

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

Llwythwch yr SVG o'r floorplanUrl . Mae pob gofod ar y llawr yn cael ei gynrychioli fel elfen SVG gydag ID yn y fformat:

space::{space_type}::{spaceId}
Nôl archebion ar gyfer llawr penodol gan ddefnyddio'r pwynt terfyn v1/public/bookings . Gallwch hidlo yn ôl ID llawr ac ystod dyddiadau i gael archebion ar gyfer diwrnod neu gyfnod penodol.
e.e.

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 }
Mapio'r spaceId o bob canlyniad archebu i'r elfen SVG gyfatebol gan ddefnyddio'r fformat ID a nodwyd uchod. Yna gallwch chi steilio'r elfen SVG yn seiliedig ar statws archebu. Er enghraifft:

llenwch: #60D27B (gwyrdd) am ar gael
llenwch: #FF9B53 (oren) ar gyfer archebu

I gadw'r cynllun llawr yn gyfredol, archwiliwch bwynt terfynol yr archebion yn rheolaidd (e.e. bob 5 munud) i adlewyrchu newidiadau argaeledd amser real.

Am enghraifft weithredol a chod ffynhonnell llawn, ewch i'n storfa GitHub ap sampl.

Trosolwg