Documentación del endpoint del recurso Indicador

Esta sección de la documentación describe el endpoint Indicador, que permite recuperar información sobre indicadores individuales o un listado de ellos, basado en filtros opcionales como área, institución y frecuencia.

Endpoint

GET /api/v1/indicator/

Este endpoint retorna datos sobre indicadores específicos o una lista de todos los indicadores disponibles, con la opción de aplicar filtros para áreas, instituciones y frecuencia de los datasets.

Autenticación

El acceso a este endpoint se asegura mediante Token Authentication. Las solicitudes deben incluir un token de acceso válido en el encabezado HTTP:

Authorization: Token YOUR_ACCESS_TOKEN

Parámetros de solicitud

Los usuarios pueden filtrar la búsqueda de indicadores utilizando los siguientes parámetros de consulta opcionales:

• indicator: ID específico de un indicador.
• area: Código de una área para filtrar indicadores relacionados con esa área.
• institution: Código de una institución para filtrar indicadores con conjuntos de datos asociados con esa institución.
• freq: Frecuencia específica para filtrar los conjuntos de datos de indicadores por su frecuencia de actualización.

Ejemplos de solicitud

Ejemplo de solicitud para un indicador específico

curl -X GET "http://datafaro.adatar.do/api/v1/indicator/?indicator=specific_indicator_id" \
     -H "Authorization: Token YOUR_ACCESS_TOKEN"

Ejemplo de solicitud con filtros

curl -X GET "http://datafaro.adatar.do/api/v1/indicator/?area=ECONREAL&institution=BCRD&freq=M" \
     -H "Authorization: Token YOUR_ACCESS_TOKEN"

Respuesta

La API devuelve información sobre el indicador o indicadores solicitados en formato JSON.

Ejemplo de Respuesta

[
    {
        "id": "pib_gasto",
        "name": "PIB por el enfoque del gasto",
        "description": "...",
        "area": "ECONREAL"
    }
    // ... otros indicadores si no se especifica un 'indicator'
]

Códigos de estado HTTP

• 200 OK: La solicitud fue exitosa.
• 401 Unauthorized: Falta el token de acceso o es inválido.
• 404 Not Found: No se encontró el indicador, área o institución especificada.
• 404 Not Found: La frecuencia especificada no es válida.

Manejo de errores

La API proporcionará un mensaje de error explicativo y un código de estado HTTP apropiado cuando no se encuentre un recurso o si hay un problema con los parámetros proporcionados.

Ejemplo de Respuesta de Error

{
    "error": "No existe un indicador con el id 'specific_indicator_id'"
}