Autenticación¶
Para el uso de esta API será necesario que todas las peticiones incluyan una cabecera con una clave que se generarará a través del la sección Claves de API del perfil de Ventana.
Solo se puede tener activada una clave, si por lo que sea la clave ha sido comprometida o ya no se va a usar más se puede revocar su uso a través de la misma sección de Claves de API de la sección de Ventana.
Además, antes de realizar la primera petición se tendrá que solicitar un token que habrá que incluir también en las peticiones y que será válido durante 20 minutos, pasado ese tiempo se tendrá que solicitar un nuevo token para lanzar nuevas peticiones.
Obtener token de autenticación¶
GET /tokens
Request¶
Header
| Key | Value | Description |
|---|---|---|
| x-api-key | {{x-api-key}} | Clave suministrada por Sarenet en la activación del servicio |
Response¶
Body
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6Ik14joxIiwibGuV2ZWwiOiIwIiwidGltZXN0YW1wIjoxNTIxMjEwMTU4fQ.Iut2ZKHxHeFKfzFSxDf3DLdZW-HKTWQjgsb2f8J1c7M"
}
El token se incluirá en todo el resto de peticiones en la cabecera Authorization.
Authorization: Bearer {{token}}
No se va a detallar en la documentación por resultar repetitivo pero todas las peticiones deberán incluir tanto la x-api-key como el token de autenticación.
Códigos de error¶
| Status | Error | Description |
|---|---|---|
| 401 | No API Key. | No se ha indicado la x-api-key |
| 401 | Unauthorised. | No se ha indicado el token |
| 403 | Invalid API Key. | x-api-key no válida |
| 429 | Too Many Requests. | Demasiadas peticiones. Ver Límites de uso |
Límites de uso¶
Existen límites en el uso de la API. Hay un límite diferente para cada grupo de consultas.
| Método | Límite |
|---|---|
| DNS | 400 consultas/hora |
En cada respuesta se recibirá en las cabeceras la información con el límite vigente en cada momento.
| Header | Description |
|---|---|
| X-Rate-Limit-Limit | Límite de consultas |
| X-Rate-Limit-Remaining | Consultas restantes |
| X-Rate-Limit-Reset | Tiempo (en segundos) restante para resetear el contador |
Si se ha superado el límite de peticiones se recibirá el error 429 Too Many Requests