Appearance
Interoperabilidad y Documentación de APIs
La sección Interoperabilidad pone a disposición del equipo técnico el catálogo de servicios de integración del Sistema Único de Identificación: APIs REST, esquemas GraphQL y documentación técnica general.
NOTA
Esta vista es principalmente informativa. No se utiliza para la gestión diaria de usuarios, pero sí para compartir las direcciones y esquemas oficiales con las áreas de tecnología o con sistemas externos que necesiten integrarse.
1. Documentación API REST Externa
La primera tarjeta, API REST Swagger / OpenAPI, reúne los endpoints públicos e interoperables del sistema:
- Qué ofrece: Explorador interactivo de endpoints REST, especificación OpenAPI y documentación de integración para autenticación, flujos de autorización y servicios federados.
- URL:
https://auth-backend-eje.app.com.bo/api/docs/ - Acciones disponibles:
- Copiar URL: Copia la dirección al portapapeles para compartirla.
- Abrir Swagger: Abre la documentación interactiva en una nueva pestaña.
2. Documentación API GraphQL Interna
El sistema expone tres esquemas GraphQL, cada uno orientado a un tipo de necesidad:
| Esquema | Ruta | ¿Para qué sirve? |
|---|---|---|
| Administración del Sistema de Identificación | /admin-schema/ | Gestión integral de identidades, usuarios, clientes OAuth2, scopes, signing keys, proveedores de identidad y flujos de aprobación. |
| API GraphQL Principal de Autenticación | /main-schema/ | Registro, gestión de credenciales, consentimientos, actualización de perfiles y operaciones autenticadas centrales. |
| API GraphQL Pública | /public-schema/ | Validación de identidades, comprobación de estados de credenciales y consultas preliminares sin autenticación previa. |
Cada tarjeta incluye:
- La descripción del esquema y su etiqueta de uso (Admin / IAM Core, Principal / Registro o Acceso Público).
- La dirección completa del esquema.
- El botón Copiar para llevar la URL al portapapeles.
- El botón Ver Schema GraphQL para abrir la documentación del esquema.
3. Documentación Técnica General
La tarjeta Manual Técnico del Sistema enlaza a la guía técnica completa: arquitectura de autenticación, despliegue, variables de entorno, llaves criptográficas, modelos de datos y flujo de interoperabilidad.
Si el enlace no está disponible, la pantalla mostrará un aviso similar a:
Variable VITE_MANUAL_TECNICO_URL no configurada en las variables de entorno.
Esto significa que el equipo técnico aún no ha publicado la dirección del manual en el entorno. En ese caso, solicite el documento al área responsable.
4. Recomendaciones de Uso
- Comparta únicamente las URLs oficiales que aparecen en esta pantalla.
- No incluya tokens, contraseñas ni llaves privadas en los esquemas o documentación que comparta.
- Los esquemas GraphQL están dirigidos a personal técnico; no es necesario ingresar a ellos para las tareas administrativas cotidianas.
- Si una URL no responde, confirme con el equipo técnico que el servicio esté desplegado en el entorno correspondiente.