Situm REST API

What is Situm REST API?

The Situm REST API allows developers to work with cartography and location data. Our API uses the HTTP protocol. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by HTTP clients. JSON is returned by all API responses, including errors.

What information can be obtained through Situm REST API?

With this API, you will be able to:
  • Fetch all your cartographic data: buildings, floorplans, points of interest, geopositioned events, etc.
  • Download the historic positioning data generated by your users.
  • Retrieve the position of every visitor in your buildings in real time.

How to consume the API?

To consume our API you can use an HTTP client. You might use Postman (Chrome) or REST Easy (Firefox) to test the requests in your browser, or httpie to test requests using the command line.
In order to consume the API, you will need to generate an API key first
Here is an example of how to fetch the information of a certain floor of a building using cURL
curl -H 'Content-Type: application/json' -H 'X-API-EMAIL: user@example.com' -H 'X-API-KEY: T9NP2lzk+jSI/Oi5DG6ODk57O0pZXdx4' "https://dashboard.situm.es/api/v1/floors/746"
Which generates the response
{
  "id": 746,
  "project_id": 411,
  "level": 0,
  "level_height": 5,
  "created_at": "2016-06-22T11:58:02.172+02:00",
  "updated_at": "2016-06-22T11:58:02.172+02:00",
  "maps": {
    "scale": 16.816295745079135,
    "map_url": "http://dashboard.situm.es/uploads/situm/floor/map/746/478ee088-96f7-4a5f-a2a4-074c6893c346.png",
  },
}