Ginia API Reference

Descubre cómo integrar sistemas externos con el Integrations Hub de Ginia. Se cubre la autenticación y el uso de las APIs públicas disponibles.

Documentación Oficial API: https://api.ginia.io/docs#/

1. Autenticación

Todas las solicitudes a la API requieren un token de API válido. El token debe enviarse en el encabezado x-api-key.

Obtención del Token

Contacte al equipo de soporte de Ginia para obtener su API Token. Este token identificará sus solicitudes y determinará a qué recursos tiene acceso (escuelas, empleos, métricas, etc.).

Uso del Token

Header obligatorio en todas las peticiones: x-api-key: su_token_aqui

2. API de Instituciones Educativas

Permite listar las instituciones a las que su token tiene acceso.

Listar Instituciones

GET /api/education-institutions

Scope Requerido: institutions:read

Ejemplo de uso:

curl -X GET <https://api.ginia.com/api/education-institutions> \\
  -H "x-api-key: su_token_aqui"

Respuesta Exitosa (200 OK):

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Universidad Autónoma de Yucatán",
    "aliases": "UADY, UAY"
  }
]

3. API de Empleos (Jobs)