๐Ÿ–ฅ๏ธ - API Endpoints
 
 

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 Authorization header 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)