Saltar al contenido principal

API REST

Gredit expone una API REST bajo el namespace /api/v1/ para consultar datos del sistema de forma programática. La autenticación se realiza mediante JWT (JSON Web Tokens).

Autenticación

La API utiliza tokens JWT para autenticar las peticiones. El token debe incluirse en el header Authorization de cada request:

Authorization: Bearer <token>

Endpoints disponibles

Casos por guion

Obtiene los casos (issues) generados por un guion específico.

GET /api/v1/scripts/:id/issues

Parámetros:

ParámetroTipoDescripción
idintegerID del guion

Casos por estado

Obtiene un resumen de casos agrupados por estado.

GET /api/v1/scripts/issues_by_status

Rutas internas relevantes

Además de la API pública, Gredit expone rutas internas para la operación del sistema:

RutaDescripción
POST /script/api_issuesObtener casos de un guion (uso interno)
GET /home/api_issues_by_statusDashboard de casos por estado
POST /issues/exportsExportar casos a archivo

SAML endpoints

Para la integración SAML, Gredit expone:

RutaDescripción
GET /saml/:tenant_name/authIniciar autenticación SAML
POST /saml/:tenant_name/callbackCallback del IdP
GET /saml/:tenant_name/metadataMetadata del SP

Ejemplo de uso

# Obtener casos de un guion
curl -H "Authorization: Bearer $TOKEN" \
https://gredit.example.com/api/v1/scripts/42/issues

# Obtener casos por estado
curl -H "Authorization: Bearer $TOKEN" \
https://gredit.example.com/api/v1/scripts/issues_by_status