This document is prepared to assist Sensgreen's customers who want to use the service by APIs.
\nThe base url of this API is https://prod.api.sensgreen.com/v2
\nFor example, you can list all your sensors via https://prod.api.sensgreen.com/v2/sensors
\nThis API uses Bearer Token to authenticate all requests.
\nTo get a valid bearer token, you need to send a post request which includes a JSON, to https://prod.api.sensgreen.com/v2/users/login.
\nThe format of the requested JSON should be in this format :
\n{\n \"email\": \"mail@mail.com\",\n \"password\": \"password\"\n}\n\n(If you need more information about https://prod.api.sensgreen.com/v2/users/login, you can take a look at the Login part.)
\nIf you sent a valid post request, this API would respond to your request as a JSON that includes two keys: users and token.
\nThe format of the responded JSON will be in this format :
\n{\n \"user\": {...},\n \"token\": \"<your-token>\"\n}\n\nThe value of this \"token\" key is your bearer token.
\nIf you sent an invalid post request, then the API would respond to your request as:
\n{\n \"message\": \"Incorrect email or password.\"\n}\n\nAfter getting this bearer token, you need to send it as an Authorization header in every other request.
\nFor example, if you want to get your building list, you should send a get request in this format:
\nGET /buildings\nheaders: {\n ...\n \"Authorization\": \"Bearer <your-token>\",\n ....\n}\n\nIf you have a valid username and password, this method will let you see your user information and your bearer token.
\nYou need to save your bearer token for every single session to get a response from the API. (If you refresh the page, you will need a new bearer token.) Because as explained in the authentication part, you need to get a Bearer Token to get a response from the API for your requests.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Sample requests for /users
\n","_postman_id":"05caa475-05ff-4d40-9ad2-29c9ba0c3b51","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This method will let you get a list of all the buildings you have.
\nIt responds to your request as a list of JSON that includes information about buildings. The ids are important in these JSONs because they are the building ids, and you will need them to make further requests.
\nFor example, when you want to see building details like the average temperature for that building whose building id is \"123456\", you need to make a request in this format :
\nGET /buildings/123456 \nheaders: {\n ...\n \"Authorization\": \"Bearer <your-token>\",\n ....\n}\n\nThen, it will return you a response with more information about that building.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This method will let you get detailed information about a specific building with a given building id.
\nIf you do not know your building id, you need to send a get request to https://prod.api.sensgreen.com/v2/buildings
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"(Required) Building Identifier
\n","type":"text/plain"},"type":"any","value":"integer","key":"buildingId"}]}},"response":[{"id":"99b0172e-0ac6-4dda-92e1-fe25c4d6765e","name":"getBuildingsDetailedExample","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerThis method will let you get information about all rooms in a building according to the given building id.
\nIt responds to your request with a list of JSON containing room information. The ids in these JSONs are room ids. If you need further details about a single room, you will use this id.
\nFor instance, when you need to get details of the room, whose room id is \"1234567\", of a building, whose building id is \"123456\", you need to make a get request in this format:
\nGET /buildings/123456/rooms/1234567 \nheaders: {\n ...\n \"Authorization\": \"Bearer <your-token>\",\n ....\n}\n\n(Required) Building Identifier
\n","type":"text/plain"},"type":"any","value":"integer","key":"buildingId"}]}},"response":[{"id":"302436ef-50e4-497f-bda1-df0e2fac8d7d","name":"getRoomsFromBuildingExample","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerSample requests for /buildings
\n","_postman_id":"f76008cd-234f-4154-b9fa-526b9a0645a0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This method will let you get detailed information like battery status and chart data about a specific room according to the given building and room id.
\nIf you do not know your room id, you can look at the getRoomsFromBuilding part.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"(Required) Building Identifier
\n","type":"text/plain"},"type":"any","value":"integer","key":"buildingId"},{"id":"21116fec-5183-44f6-8b17-6a314bc4e18a","description":{"content":"(Required) Room Identifier
\n","type":"text/plain"},"type":"any","value":"integer","key":"roomId"}]}},"response":[{"id":"0bb24d71-f2e1-475e-ad2b-329afcc017ae","name":"getRoomDetailedExample","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerThis method will let you get the most recent data that comes from this room.
\nIf you do not know your room id, you can look at the getRoomsFromBuilding part.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"(Required) Building Identifier
\n","type":"text/plain"},"type":"any","value":"integer","key":"buildingId"},{"id":"486b4491-c469-4aca-9e12-89c1bbf21cc3","description":{"content":"(Required) Room Identifier
\n","type":"text/plain"},"type":"any","value":"integer","key":"roomId"}]}},"response":[{"id":"56118120-4b20-4177-96f4-e12b934b638a","name":"getRoomLastDataExample","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerThis method will let you get all data of the room or building according to the request between selected time intervals.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"(Required) Parameter to consider.
\nHere is the parameter options: temperature, humidity, pressure, co2, voc, pm1, pm25, pm4, pm10, dew_point, iaq, p_size, current, peak_current, sound_level, no2, co, o3.
\nYou can select more than one parameter but you should separate it by using a semicolon.
\nFor example, parameter=temperature;humidity;voc
\n","type":"text/plain"},"key":"parameter","value":"string"},{"description":{"content":"(Required) Start Time.
\nTime should be in ISO Format.
\n","type":"text/plain"},"key":"startDate","value":"time"},{"description":{"content":"(Required) End Time.
\nTime should be in ISO Format.
\n","type":"text/plain"},"key":"endDate","value":"time"},{"description":{"content":"(Optional) Building Identifier.
\nIf you want to see all data that comes from all sensors that are placed on your building between selected time intervals, send the building id.
\n","type":"text/plain"},"key":"buildingID","value":"integer"},{"description":{"content":"(Optional) Room Identifier.
\nIf you want to see all data that comes from the sensor that is placed in your room between selected time intervals, send the room id.
\n","type":"text/plain"},"key":"roomID","value":"integer"}],"variable":[]}},"response":[{"id":"350b6f6e-0e61-4f22-9957-cbca4e9fe309","name":"getAllData","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer