Documentación del endpoint del recurso `Institution`

Esta sección de la documentación aborda el uso del endpoint Institution, que provee una lista de todas las instituciones registradas en la plataforma Datafaro.

Endpoint

GET /api/v1/institution/

Este endpoint retorna un conjunto de datos de todas las instituciones disponibles en el sistema.

Autenticación

La autenticación se maneja mediante Token Authentication. Para realizar solicitudes a este endpoint, los usuarios deben incluir un token válido en el encabezado de la solicitud HTTP:

Authorization: Token YOUR_ACCESS_TOKEN

Uso del endpoint

Solicitud GET

Para obtener una lista de todas las instituciones:

Realiza una solicitud GET al endpoint proporcionado.
No se requieren parámetros adicionales.

Ejemplo de solicitud

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

Respuesta

El servidor devuelve una lista de instituciones en formato JSON, con cada institución representada como un objeto con name, description, y code.

Ejemplo de respuesta

[
    {
        "code": "BCRD",
        "name": "Banco Central de la República Dominicana",
        "description": "Institución encargada de la política monetaria."
    },
    {
        "code": "ONE",
        "name": "Oficina Nacional de Estadística",
        "description": "Organismo responsable de la recopilación de datos estadísticos."
    }
    // ... más instituciones
]

Códigos de estado HTTP

200 OK: La solicitud fue exitosa y los datos se devuelven en el cuerpo de la respuesta.
401 Unauthorized: La solicitud carece de un token de acceso válido o este no fue incluido.
403 Forbidden: La solicitud está autenticada pero el usuario no tiene permisos para acceder a este recurso.
404 Not Found: El endpoint no existe o no está disponible actualmente.
500 Internal Server Error: Error general del servidor al intentar procesar la solicitud.

Mejores prácticas

Utiliza los tokens de acceso de acuerdo con las políticas de seguridad de la plataforma.
Maneja los errores de manera adecuada en tu aplicación cliente para mejorar la experiencia del usuario.

Soporte

Para asistencia o consultas relacionadas con el uso de este endpoint, por favor contacta al equipo de soporte de Datafaro.

Area Indicador

Documentación del endpoint del recurso Institution