Who's this integration guide for.
This integration guide is designed for the developers of booking, brokerage, aggregator and discovery platforms that would like to get live availability, confirm bookings and sync data back to integrated management systems.
Developers of property management systems should contact us for integration information.
The integration is broken down into steps and is designed to help drastically reduce integration time and development resources.
Before getting started.
If not completed yet, refer to docs on syncing data to get started and confirm your platform meets the base setup requirements with these use-cases:
- An existing user is able to securely connect to your platform from Syncaroo.
- An existing user is then able to map & connect their locations as needed from their management software to your platform.
- Your platform is able to receive webhook updates from Syncaroo.
- Your platform is authenticated and able to fetch live data updates via the Syncaroo API.
Current API endpoints
Locations
GET /v1/locations
or
GET /v1/locations/{ID}Some sample data points:
"Name" // String. Location Name
"Description" // String. Location Description
"TimeZone" // String. Location Timezone
"syncOpenStatus" // String. Location's current lockdown status.
"address" // Array. Location's street address.
"hoursOfOperation" // Array. Operating day and hours.
Resources
GET /v1/locations/{ID}/resources
or
GET /v1/locations/{ID}/resources/{ID}Some sample data points:
"description" // String. Resource description.
"type" // String. 'hot-desk', 'office', 'meeting-room', 'dedicated-desk', 'floor'
"units" //
"capacity" //
"Usage details" //
"size" // Integer. Size in sq ft.
"bookable" // Boolean. If is currently available for booking.
"availableFrom" // DateTime. When is next bookable.
Rates/Prices
/v1/locations/{ID}/resources/{ID}/rates
or
/v1/locations/{ID}/resources/{ID}/rates/{ID}Available Extras
GET /v1/locations/{ID}/resources/{ID}/rates/{ID}/extras
or
GET /v1/locations/{ID}/resources/{ID}/rates/{ID}/extras/{ID}Extras or addons for a specific rate for a resource (This often includes mailbox costs, lockers, or other services that are available for sale)
Files
GET /v1/locations/{ID}/resources/{ID}/files
or
GET /v1/locations/{ID}/resources/{ID}/files/{ID}Primarily images for now, but will also include other types of files attached to resources.
Live Availability
GET v1/locations/{ID}/resources/{ID}/availabilityReturns booked / times unavailable for bookings. This data can be used for internal search / caching purposes.
Booking Confirmations
POST /v1/webhooks
Returns booked / times unavailable for bookings. This data can be used for internal search / caching purposes.
