Introducción
Integrar tu aplicación con autority.io es fácil. Este API te permitirá consultas valores pendientes e información de un vehículo
El API de autority.io está diseñado como un servicio web REST. De esta forma se podrá comunicar con nuestro sistema a través de cualquier lenguaje que tenga un cliente HTTP.
Todos nuestras operaciones responde en formato JSON, así podrá enviar y recibir información de una manera sencilla.
Autenticación
La clave siempre debe estar en la cabecera de todas las solicitudes:
Authorization: {{api-key}}
Otro parámetro que siempre debe ir en la cabecera es el identificador del cliente:
X-Client-ID: {{client-id}}
Información de vehículo y valores pendientes
Información y valores pendientes por servicio
## Request
curl "https://external-api.autority.io/data/get-info-by-plate/POSTPAGO_TOLL_GUAYASAMIN/PPB4881" \
-H 'Authorization: 52ae08b704c1245wbc6faed6f81eb57b1' \
-H 'X-Client-ID: autority'
La respuesta cuando no ha habido un error:
{
"status": "success",
"code": 200,
"data": [
{
"plate": "PPB4884",
"date": "2021-08-11T11:17:00.000Z",
"value": 1.2
},
{
"plate": "PPB4884",
"date": "2021-08-11T11:35:00.000Z",
"value": 1
}
]
}
La respuesta cuando ha habido un error:
{
"status": "error",
"code": 400,
"error": "Timed out after waiting 10000ms",
"data": {
"lastUpdate": "2023-10-04T22:11:30.458Z",
"data": [
{
"plate": "PPB4884",
"value": 0.4,
"date": "2021-08-11T11:17:00.000Z"
},
]
}
}
Este endpoint devuelve los valores pendientes o información por tipo de servicio
HTTP Request
GET https://external-api.autority.io/data/get-info-by-plate/:service_identify/:identify
URL Parameters
Parámetro | Type | Description |
---|---|---|
service_identify | SERVICES | Identificador del servicio del que se quiere obtener la información |
identify | String | identificador del vehículo del que se quiere obtener la información. |
Obtener el número de solicitudes
## Request
curl "https://external-api.autority.io/data/get-count-request" \
-H 'Authorization: 52ae08b702c045bba6faed6f81eb57b1' \
-H 'X-Client-ID: autority'
La respuesta cuando no ha habido un error:
{
"status": "success",
"code": 200,
"data": [
{
"service": "POSTPAGO_TOLL_GUAYASAMIN",
"count": "4"
},
{
"service": "POSTPAGO_TOLL_PICHINCHA",
"count": "1"
}
]
}
Este endpoint devuelve el número de solicitudes que se han realizado de forma correcta
HTTP Request
GET https://external-api.autority.io/data/get-count-request
Tipos
SERVICES
Values |
---|
POSTPAGO_TOLL_PICHINCHA |
POSTPAGO_TOLL_GUAYASAMIN |
TOLL
{
"plate": "PPB4884",
"date": "2021-08-11 06:17:00",
"value": 1.2
}
Key | Type | Description |
---|---|---|
plate | String | placa |
date | ISO Date | fecha de la pasada |
value | Number | valor de la pasada |
Errors
The Kittn API uses the following error codes:
Error Code | Meaning |
---|---|
400 | Bad Request -- Your request is invalid. |
401 | Unauthorized -- Your API key is wrong. |
500 | Internal Server Error -- We had a problem with our server. Try again later. |
503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. |
# Response
{
"status": "error",
"code": 400,
"error": "Timed out after waiting 10000ms",
"data": {
"lastUpdate": "2023-10-04T22:11:30.458Z",
"data": [
{
"type": "PEAJE SIN TAG GUAYASAMIN",
"id": "10030788",
"plate": "PPB4884",
"value": 0.4,
"date": "2023-09-26T23:02:26.000Z",
"datePayed": null,
"payed": false,
"creation": "2023-10-04T22:07:55.218Z",
"lastUpdate": "2023-10-04T22:07:55.218Z",
"idRubro": null
},
]
}
}
Key | Type | Description |
---|---|---|
lastUpdate | ISO Date | fecha de la útlima actualización de la data |
data | TOLL | Dependiendo del servicio devolvera la correspondiente estructura |