API Overview

We provide a set of REST API that lets you create, update, get, and delete Users, events, location, trips and Geofences, which will help you to do more with our product.

This page describes our authentication model, API endpoints and error handling while using our apis.

Base URL

All URLs referenced in the API documentation will have the following base:

URL

                                  
                                      
  https://api.geospark.co
                              
                              

REST APIs are served over HTTPS. To ensure data privacy, we discourage using unencrypted HTTP requests.

Jump Start

Quickly learn to start using our APIs through API Quickstart Guide .

API Use Cases

Here are some popular use cases with our API:

  • Can be used to view and do much more with your user data.
    • Enables you to view user count per project.
    • Enables you to determine the device(iOS/Android) and application from which the hits are coming from.
  • Can create, update, and delete Geofences, and trigger events on the fly
    • Use geofences to create virtual for your structural properties on maps.
    • Track your users as they enter and exit geofences.
    • Understand user behaviour and usage, as well as visit patterns.
  • Locations apis for tracking your users movement and activities.
    • Know the users location in real time by just calling our APIs.
  • Trips APIs can be used to view your user trips and routes
    • Track the trip of the user.
    • Fetch path of the trips along with the routes,mode of transportation, stop points and offline status.

Authentication

We use a basic authentication for the APIs taking into consideration the safety of your API secret keys. We provide APIs on a per project basis so that other projects remain unaffected in the uneventful case of one projects API being compromised.

API Endpoints

Once your application is integrated with Geofence SDK, account for each user using your app will be created. Information about these users can be tracked through our APIs.

Here are the API endpoints available to interact with the user profile data:

  • Get User API

    The Get User API lets you download user data chronologically, which gives you a lot of useful information such as which application the user is using, the device they are using (iOS or Android), whether the user is deleted or not, and when they joined your app.

  • Get Location API

    The Get Location API lets you download user location data chronologically. The response also has other useful info such as battery percentage, activity status, recorded time of the location, etc which can give useful insights about the user.

  • Geofence API Create/Get/Update/Delete

    This set of APIs lets you create, get, update, and delete geofences, specific to the project and helps you to keep track of them . The same operation can be performed from the website dashboard as well.

    They also allow you to enable these geofences for triggering events.

    Note: By default, GeoFences are not "event trigger" enabled. To make a geofence "event trigger" enabled, update that particular geofence using Update API and pass the below option.

    JSON

                                      
                                          
      {"is_enabled": true}
    
                                  
                                  
  • Get Event API

    The Get Events API lets you download the events of entry or exit of your users from your event enabled geofences. The API also lets you filter user wise or geofence wise, or location wise and other options detailed in the API Quickstart guide below .

  • Get Trips List API

    The Get Trips API lets you download the trips data of all active ongoing and completed trips for your users.

  • Get Trip Route API

    The Get trips route api lets you download the trip's "route specific data" for the completed trips . This will give the path/route taken by the user for trips.