This API makes available the emergency stop service.
\nIt can:
\nSend commands to vehicles by 3 different types of identifiers, as batch.
\nQuery batch status.
\nQuery vehicle status.
\nAuthentication: All endpoints require (except login):
\nAuthorization: Bearer — Waypoint user session token (obtained by the login endpoint)
id-client: — ID of the client the vehicles belong to
x-api-key: — API key assigned to the client
Endpoints resume:
\nhttps://api.waypoint.cl/parada-emergencia/vehicles
\nRequest Type: POST
\nSecurity: yes
\nid-client (int from authorized client)
Bearer token (from user obtained through login)
\napi-key (given to the client)
\nhttps://api.waypoint.cl/parada-emergencia/vehicles-status
\nRequest Type: POST
\nSecurity: yes
\nid-client (int from authorized client)
Bearer token (from user obtained through login)
\napi-key (given to the client)
\nhttps://api.waypoint.cl/parada-emergencia/batch-status
\nRequest Type: GET
\nSecurity: yes
\nid-client (int from authorized client)
Bearer token (from user obtained through login)
\napi-key (given to the client)
\nRetrieves the Waypoint user session token. The returned token must be used as the value of the Authorization header (with the Bearer prefix) in all other endpoints.
Credentials are declared in the body.
\n{ \"AccessToken\": \"eyJraWQiOiJEREhzTFdYUURUOGpBYSt4...\"}\n\n{ \"error\": {}}\n\n{ \"error\": \"Invalid password for user USER\"}\n\nSends an emergency stop activation (LOCK) or deactivation (UNLOCK) command for one or more vehicles, identified by 3 possible options: plate, VIN, or internal_code. It returns a batch id needed for the batch_status endpoint in order to track the status of the commands. It also return a list of vehicles that failed validation at some point.
\nBody fields:
\naction: LOCK (stop) or UNLOCK (resume)
id_type: PLATE (license plate), INTERNAL_CODE (internal name), VIN (chassis number)
vehicles: array of identifiers matching the chosen id_type
The response examples show the variants by id_type and the possible status codes.
Queries the last emergency stop status for one or more vehicles.
\nBody fields:
\nid_type: PLATE (license plate), INTERNAL_CODE (internal name), VIN (chassis number)
vehicles: array of identifiers
Vehicles not found in the system are returned in not_found.
Queries the processing status of a batch previously submitted via POST /vehicles.
Use the batch_id returned in the 202 response from the vehicles endpoint.
Query params:
\nbatch_id (required): batch UUIDUUID returned by POST /vehicles in the batch_id field
\n","type":"text/plain"},"key":"batch_id","value":"{{batch_id}}"}],"variable":[]}},"response":[{"id":"aa2e2aeb-4e17-4e45-9ee8-824aded8a327","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"id-client","value":"{{id-client}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"url":{"raw":"https://api.waypoint.cl/parada-emergencia/batch-status?batch_id={{batch_id}}","protocol":"https","host":["api","waypoint","cl"],"path":["parada-emergencia","batch-status"],"query":[{"key":"batch_id","value":"{{batch_id}}","description":"UUID returned by POST /vehicles in the batch_id field"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"batch_id\": \"aae37fb3-5da0-440d-af58-0d7b74972419\",\n \"batch_status\": \"IN_PROGRESS\",\n \"requests\": [\n {\n \"id\": 101,\n \"plate\": \"ABCD12\",\n \"vin\": \"KS918KA7129LN\",\n \"internal_code\": null,\n \"status\": \"EXECUTED\",\n \"command_type\": \"LOCK\",\n \"platform\": \"ANDROID\",\n \"requested_at\": 1743090000000,\n \"executed_at\": 1743090005000,\n \"cancelled_at\": 0\n },\n {\n \"id\": 102,\n \"plate\": \"EFGH34\",\n \"vin\": null,\n \"internal_code\": \"F130 EFGH34\",\n \"status\": \"CREATED\",\n \"command_type\": \"LOCK\",\n \"platform\": \"ANDROID\",\n \"requested_at\": 1743090000000,\n \"executed_at\": 0,\n \"cancelled_at\": 0\n }\n ]\n}"},{"id":"26a269b3-4e6e-4f3c-89ac-e14a1a99b753","name":"400 Bad Request — missing batch_id","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"id-client","value":"{{id-client}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"url":{"raw":"https://api.waypoint.cl/parada-emergencia/batch-status?batch_id={{batch_id}}","protocol":"https","host":["api","waypoint","cl"],"path":["parada-emergencia","batch-status"],"query":[{"key":"batch_id","value":"{{batch_id}}","description":"UUID returned by POST /vehicles in the batch_id field"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Parameter batch_id required\"\n}"},{"id":"3de2d12f-112e-4cae-897b-f6b009738af6","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"id-client","value":"{{id-client}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"url":{"raw":"https://api.waypoint.cl/parada-emergencia/batch-status?batch_id={{batch_id}}","protocol":"https","host":["api","waypoint","cl"],"path":["parada-emergencia","batch-status"],"query":[{"key":"batch_id","value":"{{batch_id}}","description":"UUID returned by POST /vehicles in the batch_id field"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Authorization header required\"\n}"},{"id":"961cafaf-2fc2-45d9-89d7-bedf8fc398c6","name":"403 Forbidden — no access to client","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"id-client","value":"{{id-client}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"url":{"raw":"https://api.waypoint.cl/parada-emergencia/batch-status?batch_id={{batch_id}}","protocol":"https","host":["api","waypoint","cl"],"path":["parada-emergencia","batch-status"],"query":[{"key":"batch_id","value":"{{batch_id}}"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"You do not have access to the specified client\"\n}"},{"id":"d79abc31-b42d-4e2f-9474-ac8d3c2c8597","name":"502 Bad Gateway — backend unavailable","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"id-client","value":"{{id-client}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"url":{"raw":"https://api.waypoint.cl/parada-emergencia/batch-status?batch_id={{batch_id}}","protocol":"https","host":["api","waypoint","cl"],"path":["parada-emergencia","batch-status"],"query":[{"key":"batch_id","value":"{{batch_id}}","description":"UUID returned by POST /vehicles in the batch_id field"}]}},"status":"Bad Gateway","code":502,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error fetching batch status\"\n}"}],"_postman_id":"63b617a0-4cb6-4436-9ef8-d038176c6bb6"}]}