API documentation for user/authenticate

Back to main page
URL
/api/v1/user/authenticate

Athenticate user and return a temperary API token.

Username and password must be passed as POST parameters with username and password as keys. Both are required.

When authentication is successful the following is returned (the contents of token will be different for you):

{"ok": true, "token": "702811da14ff4225973c4054ed52bb9f"}

When there are missing parameter or when authentication is not successful one of the following lines is returned:

{"ok": false, "message": "missing username and/or password"}
{"ok": false, "message": "username and/or password wrong"}

Available API endpoints:

URL Description
/api/v1/user/authenticate Athenticate user and return a temperary API token.
/api/v1/user/account Get user account by API token.
/api/v1/token_details Tests the token and returns account info if the token is valid.
/api/v1/list_measuring_points Gives a list of measuring points that this token can access.
/api/v1/configure_measuring_point Configure a measuring point.
/api/v1/list_sensors Gives a list of sensors that this token can access.
/api/v1/get_peak_records Fetch peak particle velocity/acceleration records for a given measuring point.
/api/v1/get_vdv_records Fetch VDV records for a given measuring point.
/api/v1/get_veff_records Fetch Veff/KB records for a given measuring point.
/api/v1/get_traces_list Get a list of traces for a given time range.
/api/v1/get_traces Get detailed traces for a given time range.