REST is HTTP based interface providing the following methods: GET, CREATE, UPDATE, DELETE. All methods along with the responses are encapsulated in JSON format and transferred as HTTP requests. With each request, a response is given from the server. The communication is based on request-response architecture, which means that the user need to frequently request position updates to receive the positioning data.
Data Entities Terminology
Data entities within RTLS Software are divided into three basic groups:
- Feed – it is most general data representation of physical object or device such as Tag, Building, Zone Definition etc.
- Datastream – it is representation of physical phenomena such as position, battery level, orientation etc.
- DataPoint – it is representation of discrete measurement of datastream equipped with timestamp
There are other entities derived from basic Feed such as:
- Anchor - represents physical anchor device and its data
- Tag - represents physical tag device and its data
- Building - represents physical building and its data
When to use REST Interface?
REST Interface is mainly useful for applications with refresh rates in seconds or to read static data from the database, like information about Tags, Anchors, Buildings, Zones, etc. It can also be used to read historic position data. REST interface should not be used to read fast real-time position data. The user authentication is done by the use of an API Key. Since the RTLS Studio provides multi-user access, the rights to data entities and request itself must be sent with authentication key in HTTP headers. You can manage your apikey in User Management.
Interactive API REST Interface DEMO AVAILABLE
You can play with API in our interactive API interface documentation, which is available online and it is also included in native part of RTLS Studio installation:
RTLS Studio native installation has available the same interactive REST documentation at following path: YOUR_RTLSSTUDIO_IP_ADDRESS/documentation/api-rest