This section provides an overview of the GeoAR.it API and its capabilities.
๐ Overview
- ๐ GeoAR.it API: Interact with venues, hotspots, and prefabs in a geospatial AR context.
- โฑ๏ธ Rate Limit: 1 call per second.
- ๐ Authentication: Bearer JWT tokens in each request.
- ๐ก Sample code is available on the API documentation page.
This section links you to a live sample web app for testing API endpoints.
๐งช Sample Web App
This section explains how to authenticate API requests using Bearer tokens.
๐ Authentication
- ๐ Bearer Token Authentication: Include your JWT in the
Authorizationheader for every request. - ๐
Authorization: Bearer <your_token_here>
This section lists the available API endpoints for working with venues, hotspots, and prefabs.
๐ก API Endpoints
- ๐๏ธ Get Venue Details:
GET /api/v{v}/venues/{venueGuid} - ๐๏ธ Get All Venues:
GET /api/v{v}/venues/{includeDemos} - ๐ Get Hotspots for a Venue:
GET /api/v{v}/venues/{venueGuid}/hotspots/{maxToLoad} - ๐ Get Nearby Venues:
GET /api/v{v}/venues/nearby/{lat}/{lng}/{radiusMeters}/{includeDemos}/{maxToLoad} - ๐ Get Hotspot Details:
GET /api/v{v}/hotspots/{hotspotGuid} - ๐ Get Hotspots in KML Format:
GET /api/v{v}/venues/{venueGuid}/hotspots/kml/{maxToLoad} - ๐ Update Hotspot Geolocation:
PUT /api/v{v}/hotspots/{hotspotGuid}/geoLocation/{lat}/{lng}/{alt} - ๐ Add or Update Hotspot Property:
PUT /api/v{v}/hotspots/{hotspotGuid}/property - ๐ Delete Hotspot Property:
DELETE /api/v{v}/hotspots/{hotspotGuid}/property - ๐งฑ Get Prefab Details:
GET /api/v{v}/prefabs/{prefabGuid}
This section documents the schemas for Venue, Hotspot, and Prefab objects in the API.
๐งพ Schemas
- ๐๏ธ Venue:
id(integer)guid(UUID)name(string)address(string)postcode(string)latitude(float)longitude(float)enabled(boolean)enabledFrom(datetime)enabledTo(datetime)
- ๐ Hotspot:
id(integer)guid(UUID)name(string)latitude(float)longitude(float)altitude(double)enabled(boolean)prefabGuid(UUID)
- ๐งฑ Prefab:
id(integer)guid(UUID)name(string)unityName(string)type(string)imageUrl(string)modelUrlGlb(string)