Added API docs and Serial Interface docs. To access the API docs, click on "docs" in the navbar. For the Serial docs, just type "help" on the serial CLI.
Endpoint | HTTP Method | Parameters | Description |
---|---|---|---|
/ | GET | N/A | Serves the index.html file |
/version | GET | N/A | Returns the version number |
/gpio | POST | output, state | Controls the GPIO pin |
/state/relay | GET | N/A | Returns the state of relay1 |
/settings/relaydisabled | GET, POST | value | Gets or sets the relay disabled value |
/settings/relaymode | GET, POST | value | Gets or sets the relay mode currently "LATCH" or "TOGGLE" |
/settings/tinance2creds | GET, POST | identifier, key | Gets or sets the Tinance credentials |
/settings/tinance2url | GET, POST | url | Gets or sets the Tinance URL |
/settings/tinance2validatecardurl | GET | N/A | Returns the validate card URL |
/settings/tinance2readerinfourl | GET | N/A | Returns the reader info URL |
/settings/tinance2aclsurl | GET | N/A | Returns the ACLs URL |
/settings/tinance2logurl | GET | N/A | Returns the reader log URL |
/settings/webhooklockenabled | GET, POST | value | Gets or sets the webhook lock enabled value |
/settings/webhooklockhook | GET, POST | value | Gets or sets the webhook lock hook |
/settings/webhookunlockenabled | GET, POST | value | Gets or sets the webhook unlock enabled value |
/settings/webhookunlockhook | GET, POST | value | Gets or sets the webhook unlock hook |
GET, POST | N/A | lists all local / backup user | |
/users/create | GET, POST | cardid, desc | Creates a local / backup user |
/users/update | GET, POST | cardid, newCardId, desc | updates a local / backup user if cardid is the same set newCardId to same value. |
/users/remove | GET, POST | cardid | removes a local / backup user |