gSMS API
The gSMS API provides a flexible interface designed to integrate sensor data into your custom applications and systems. Whether you’re monitoring environmental conditions, tracking equipment, or analyzing critical metrics, the gSMS API offers a streamlined way to collect, process, and utilize sensor information that is stored on our online portal.
In this manual, you will find all the information you need to get started, including endpoint details and request/response formats.
Bearer Token
Data is only accessible to eligible users. The enable secure data transfer, the gSMS API uses a Bearer Token for authentication. A Bearer Token is a type of access token used in authentication to grant secure access to a protected resource, such as this API. When a client includes a Bearer Token in the Authorization
header of an HTTP request (formatted as Authorization: Bearer <token>
), it serves as proof that the client is authorized to access specific resources. This token is typically issued by an authentication server and has a limited lifespan for security purposes, ensuring that only authenticated users or systems can access the API endpoints.
Endpoints
Login (get bearer token)
Endpoint |
CODE
|
---|---|
Bearer token required | no |
Query params |
CODE
|
Description | Endpoint to convert the login credentials to a bearer token that will be used in the following API calls |
Method | POST |
Response |
CODE
|
Example response |
CODE
|
Get sensors
Endpoint |
CODE
|
---|---|
Bearer token required | Yes |
Query params | - |
Description | Endpoint to get a list of sensors that are accessible by the user |
Method | GET |
Response |
CODE
|
Example response |
CODE
|
Get Data
Endpoint |
CODE
|
---|---|
Bearer token required | Yes |
Query params | Mandatory
CODE
Optional (but recommended) time filtering Use a UNIX timestamp in milliseconds (milliseconds since 1970, similar to the timestamp in all Medusa JSONS)
CODE
CODE
Optional:
CODE
|
Description | Endpoint to get data from a specific sensor where the requested data can be specified |
Method | GET |
Response |
CODE
|
Example response |
CODE
|