Documentación | Datafaro
Introducción a la API de DataFaro
Recursos disponibles en la API
Frecuencia

Documentación del endpoint Frequency

El endpoint Frequency de la API de Datafaro proporciona una lista de las frecuencias de tiempo disponibles para los conjuntos de datos en la plataforma.

Endpoint

GET /api/v1/frequency/

Este endpoint se utiliza para recuperar una lista de todas las frecuencias posibles con las que se pueden actualizar los conjuntos de datos en Datafaro.

Autenticación

El acceso a este endpoint requiere autenticación mediante Token Authentication. Los usuarios deben incluir su token de acceso en el encabezado de la solicitud HTTP:

Authorization: Token YOUR_ACCESS_TOKEN

Respuesta

La API devuelve una lista de las frecuencias de tiempo disponibles, cada una representada por un código, su descripción y su equivalencia en segundos.

Ejemplo de solicitud

Para obtener la lista de frecuencias:

curl -X GET "http://datafaro.adatar.do/api/v1/frequency/" \
     -H "Authorization: Token YOUR_ACCESS_TOKEN"

Ejemplo de respuesta

La API devolverá una lista de frecuencias en formato JSON:

[
    {
        "code": "H",
        "description": "Hora(s)",
        "seconds": 3600
    },
    {
        "code": "D",
        "description": "Día(s)",
        "seconds": 86400
    },
    {
        "code": "W",
        "description": "Semana(s)",
        "seconds": 604800
    },
    // ... más frecuencias
]

Códigos de estado HTTP

  • 200 OK: La solicitud fue exitosa y los datos se devuelven en el cuerpo de la respuesta.
  • 401 Unauthorized: Falta el token de acceso o es inválido.

Uso

Este endpoint es útil para:

  • Determinar las diferentes frecuencias con las que se pueden actualizar los conjuntos de datos.
  • Integrar la información de frecuencia en aplicaciones y sistemas que consuman datos de Datafaro, permitiendo un manejo más eficiente de los intervalos de actualización de datos.

Notas adicionales

  • La lista de frecuencias se presenta con un código, una descripción legible y su duración en segundos, facilitando su interpretación y uso en diversos contextos.
  • Asegúrate de que tu aplicación cliente maneje correctamente estas frecuencias, especialmente si se utilizan para programar tareas o sincronizaciones.
MetadatosEstado