This is the API for the Step Smart system.
It allows the app and Arduino to send and receive data to the databse and therefore communicate with each other.
- express
- morgan
- pg
- cors
- DATABASE_URL
- PORT
To install dependencies run: npm i
To run locally: npm run dev
Can then use Postman to test api at url localhost:3000/StepSmart/api/?code=12345678
API is at /StepSmart/api/
A code is required: /StepSmart/api/?code=12345678
The PATCH method requires a body in json format
Endpoint | Method | URL | JSON Body Format |
---|---|---|---|
All data | GET | /StepSmart/api?code=12345678 |
NA |
Devices | GET/POST | /StepSmart/api/devices?code=12345678 |
{"devices":"ExponentPushToken[123ABC]"} |
Alert data | GET/PATCH | /StepSmart/api/alert?code=12345678 |
{"alert": "0", "fall": "60", "alarm": "60", "volume": "5"} |
Contacts | GET/PATCH | /StepSmart/api/contacts?code=12345678 |
['{"name":"Jack", "phoneNumber":"012345678901"}'] |
Lost mode | GET/PATCH | /StepSmart/api/lost?code=12345678 |
{"lostMode": false} |
Heart rate data | GET/PATCH | /StepSmart/api/heart?code=12345678 |
{"logging": "1", "times": [], "readings": []} |
Heart rate value | POST | /StepSmart/api/heartBpm?code=12345678 |
{"value": 60} |
Battery level | GET/PATCH | /StepSmart/api/battery?code=12345678 |
{"battery": 60} |
Emergency | GET/PATCH | /StepSmart/api/emergency?code=12345678 |
{"emergency": false} |
- Peter Metcalfe