La API Pública es una herramienta que permite a los desarrolladores interactuar con la plataforma Eskuad y acceder a datos e información relevante. Esta documentación tiene como objetivo describir de manera detallada los endpoints disponibles, los parámetros aceptados y las respuestas esperadas, y servir como guía para la correcta integración con la API.
Todos los endpoints de la API Pública requieren autenticación. Para poder acceder a la información de la plataforma, los desarrolladores deben incluir una API key en las solicitudes. La key puede ser obtenida por cualquier administrador en la plataforma, accediendo a la configuración, en el sub-menú de integraciones.
Una vez ahí se debe seleccionar la opción “Crear nueva key”. Luego dar una descripción para la key (ej. “Key para integración con PowerBI”), junto con el nivel de permisos que se otorgarán con la key: sólo lectura o lectura/escritura.
Una vez creada, la nueva key de acceso estará en la columna key.
Para incluir la API key en las solicitudes, se debe agregar el siguiente header:
api-key: <apikey>
Para utilizar la API Pública, se debe hacer una solicitud a la siguiente URL base:
<https://api.eskuad.com/api>
Es importante asegurarse de incluir la API key en todas las solicitudes.
Luego de la URL base, se debe indicar la versión del endpoint que se usará. Actualmente todos los endpoints se encuentran en la versión 1, por lo que la url base quedará como sigue:
<https://api.eskuad.com/api/v1>
La API Pública cuenta con los siguientes endpoints.