Information
- License: Proprietary
- OpenAPI version:
3.1.0
Overview
Spaces REST API 1.0.0
Section titled “Spaces REST API 1.0.0”The Spaces REST API enables programmatic access and management of Spaces indoor navigation installations.
Operations available through the API include:
- Creating, updating and removing landmarks (visitor destinations) within the Space
- Exporting and importing data, including in standardised formats such as IMDF GeoJSON
- Querying routes in the Space between landmarks or 3D coordinates, including constraints (e.g. step-free, avoid elevators), returning route summaries (distances, steps, number of elevators used) and waypoints
- Determining nearby Spaces given a geohash
- Managing public access to a Space, and other settings
- Creating, updating and removing structural elements, such as obstacles and floors
Changes made to a Space are merged in real-time with changes from other API requests, and with users managing the Space with the frontend Spaces web app.
This API mutates the canonical data for a given Space. For the purposes of version control and content delivery, visitor access to publicly available Spaces is made through a public serialization of the canonical data. The public version of the data is updated within 15 seconds of canonical data updates, and may be cached for up to 15 seconds. As a result, it may take up to 30 seconds for changes made via API to a Space to appear to unauthenticated public visitors.
The API endpoint for a Space may vary depending on data residency and other factors. As a result, relative paths are used throughout this documentation. The Zappar team can provide the correct API endpoint for any Space with which you wish to use the API.
Use of this API is subject to rate limits. Please contact Zappar to arrange limits to cover your intended use case.
Authentication
For Zappar-hosted Spaces instances, API authentication is with a Zapworks API key, user token, or exchanged OIDC token.
If you have OIDC configured with Zapworks, you can use the /auth/token endpoint to exchange an OIDC token for a short-lived access token for use with the API.
If you with to access the API key in a browser using a user token, you must register an OAuth 2.0 application with the Zappar team. Please get in touch with us if you wish to investigate this route.
If you use an independent deployment of Spaces, or you self-host, additional authentication options are available. Contact the Zappar team for more information.
Authentication
Section titled “Authentication”A ZapWorks API key or user token with access to the project. It can also be sent bare, without Bearer.
Security scheme type: http