Herramientas para Desarrolladores
La sección Desarrollador de la Consola Auris proporciona un conjunto de herramientas para construir, probar y depurar integraciones con Auris. Estas herramientas están diseñadas para reducir el tiempo entre “quiero integrar Auris” y “la autenticación funciona en mi aplicación.”
Accede al Hub de Desarrolladores en Consola → Desarrollador → Hub.
Resumen del Hub de Desarrolladores
El Hub de Desarrolladores es una página de inicio con seis tarjetas que enlazan a cada herramienta para desarrolladores:
| Herramienta | Icono | Descripción |
|---|---|---|
| API Explorer | Globo | Explora y prueba todos los endpoints de la API Auris |
| Decodificador de Tokens | Llave | Decodifica e inspecciona tokens JWT |
| Sandbox | Terminal | Prueba llamadas a la API contra tu tenant |
| Quickstarts | Cohete | Asistente de configuración interactivo para tu aplicación |
| Herramienta CLI | Terminal | Referencia de la interfaz de línea de comandos |
| Resumen de SDKs | Paquete | Comparación de características entre todos los paquetes SDK |
Adicionalmente, la página de Documentación para Desarrolladores proporciona guías de referencia inline con bloques de código para tareas de integración comunes.
API Explorer
El API Explorer proporciona una referencia navegable de todos los endpoints de la API Auris, organizados en 9 secciones. Accede en Consola → Desarrollador → API Explorer.
Secciones de la API
| Sección | Endpoints | Descripción |
|---|---|---|
| Auth | Login, registro, intercambio de tokens, refresh, logout, verificación MFA, magic link, login social | Flujos de autenticación principales |
| Users | CRUD, búsqueda, habilitar/deshabilitar, metadatos, sesiones, gestión 2FA | Gestión del ciclo de vida de usuarios |
| Roles | CRUD, asignación de permisos, comprobaciones de permisos basadas en roles | Configuración RBAC |
| Organizations | CRUD, miembros, invitaciones, conexiones SSO | Gestión multi-organización B2B |
| FGA | Modelos, tuplas, check, expand, list-objects | Autorización Detallada |
| Apps | CRUD de aplicaciones, rotación de secretos, claims personalizados, tokens M2M | Configuración de aplicaciones |
| Webhooks | CRUD, prueba, historial de entregas, rotación de secretos | Gestión de webhooks salientes |
| OIDC | Documento de descubrimiento, JWKS, authorize, userinfo | Endpoints estándar de OpenID Connect |
| SCIM | Users, Groups, ServiceProviderConfig, Schemas, Bulk | Aprovisionamiento SCIM 2.0 |
Usando el API Explorer
Cada sección se expande para mostrar endpoints individuales con:
- Método HTTP y ruta (por ejemplo,
POST /api/auth/token) - Parámetros de la solicitud: Parámetros de consulta, parámetros de ruta y esquema del cuerpo de la solicitud
- Formato de respuesta: Ejemplos de cuerpos de respuesta de éxito y error
- Requisito de autenticación: Qué endpoints requieren un token Bearer y cuáles son públicos
El API Explorer es una herramienta de referencia — muestra el formato de solicitud y respuesta pero no ejecuta llamadas a la API. Usa el Sandbox para pruebas en vivo.
Decodificador de Tokens
El Decodificador de Tokens te permite pegar cualquier JWT y ver su contenido decodificado. Accede en Consola → Desarrollador → Decodificador de Tokens.
Cómo Usarlo
Pegar un JWT
Copia un token de acceso, token de identidad o cualquier otro JWT y pégalo en el área de texto.
Ver la salida decodificada
El decodificador divide el JWT en sus tres partes y las muestra:
Encabezado:
{
"alg": "RS256",
"kid": "key-id-1",
"typ": "JWT"
}Payload:
{
"sub": "usr_abc123",
"iss": "https://auth.yourcompany.com",
"aud": "your-client-id",
"iat": 1739880000,
"exp": 1739880900,
"email": "[email protected]",
"roles": ["editor"],
"acr": "urn:auris:acr:mfa",
"amr": ["pwd", "otp"]
}Comprobar la validez del token
El decodificador muestra:
- Estado de expiración: Si el token sigue siendo válido o ha expirado (comparando
expcon la hora actual) - Hora de emisión: Hora de emisión en formato legible
- Tiempo restante: Para tokens válidos, cuánto tiempo queda hasta la expiración
Casos de Uso Comunes
- Depurar claims: Verificar que los claims personalizados, roles y scopes están presentes en el token
- Comprobar expiración: Determinar si un error
401es causado por un token expirado - Verificar ACR/AMR: Confirmar que los claims de autenticación step-up están incluidos tras MFA
- Inspeccionar tokens M2M: Comprobar
type: "m2m"y claims de scope para tokens de credenciales de cliente - Validar DPoP: Comprobar el claim
cnf.jkten tokens vinculados a DPoP
El Decodificador de Tokens decodifica el payload del JWT sin verificar la firma. Esto es intencionado — es una herramienta de depuración. En producción, siempre verifica las firmas usando el endpoint JWKS. Consulta Tokens Explicados para orientación sobre verificación.
Sandbox
El Sandbox proporciona un entorno de pruebas de API en vivo conectado a tu tenant. Accede en Consola → Desarrollador → Sandbox.
Cómo Funciona
El Sandbox rellena previamente las cabeceras de autenticación con tu token de sesión de administrador actual y la cabecera x-tenant con tu ID de tenant. Puedes:
- Seleccionar un endpoint de la API del menú desplegable (organizado por las mismas 9 secciones que el API Explorer)
- Rellenar los parámetros de la solicitud (parámetros de ruta, consulta, cuerpo)
- Hacer clic en Enviar para ejecutar la solicitud contra la API Auris en vivo
- Ver el código de estado de la respuesta, las cabeceras y el cuerpo
Contexto Rellenado Previamente
| Campo | Valor | Fuente |
|---|---|---|
| URL Base | Tu URL de la API Auris | Desde la configuración del tenant |
| Authorization | Bearer {tu-token-admin} | Desde tu sesión actual en la Consola |
| x-tenant | Tu slug de tenant | Desde tu sesión actual en la Consola |
Esto significa que puedes probar endpoints de inmediato sin construir manualmente las cabeceras.
Ejemplo: Probar una Comprobación de Permisos
- Selecciona
POST /api/roles/checkdel menú desplegable de endpoints - Introduce el cuerpo de la solicitud:
{
"userId": "usr_abc123",
"permission": "view:invoices",
"applicationId": "app_xyz789"
}- Haz clic en Enviar
- Ve la respuesta:
{
"ok": true,
"data": {
"allowed": true,
"source": "role_permission",
"role": "editor"
}
}Quickstarts
El asistente de Quickstarts proporciona instrucciones paso a paso para integrar Auris en tu aplicación. Accede en Consola → Desarrollador → Quickstarts.
Asistente de Configuración Interactivo
El asistente guía a través de tres pasos:
Seleccionar tu aplicación
Elige una aplicación existente de tu tenant, o haz clic en Crear Aplicación para registrar una nueva. El asistente necesita una aplicación para rellenar previamente el clientId y domain en los fragmentos de código.
Seleccionar tu framework
Elige tu framework de desarrollo. Cada tarjeta de framework muestra el paquete SDK correspondiente:
| Framework | Paquete SDK | Descripción |
|---|---|---|
| JavaScript | @auris/js | JavaScript básico (navegador o Node.js) |
| React | @auris/react | Provider + hooks de React |
| Next.js | @auris/nextjs | Helpers de servidor + middleware Edge |
| PHP | auris/sdk | Paquete Composer para aplicaciones PHP |
| WordPress | auris-sso | Plugin SSO de WordPress |
| Laravel | auris/sdk | SDK PHP con orientación específica para Laravel |
Seguir los fragmentos de código
El asistente muestra código específico del framework con el clientId y dominio de tu aplicación rellenados previamente:
Instalación:
npm install @auris/reactConfiguración del Provider:
import { AurisProvider } from '@auris/react'
function App({ children }) {
return (
<AurisProvider
domain="auth.yourcompany.com"
clientId="your-actual-client-id"
>
{children}
</AurisProvider>
)
}Botón de login:
import { useAuris } from '@auris/react'
function LoginButton() {
const { loginWithRedirect, isAuthenticated, user } = useAuris()
if (isAuthenticated) {
return <p>Bienvenido, {user.name}</p>
}
return <button onClick={() => loginWithRedirect()}>Iniciar Sesión</button>
}Temas Avanzados
Debajo del asistente principal de 3 pasos, la página de Quickstarts incluye una sección de Temas Avanzados con fragmentos de código para:
| Tema | Descripción |
|---|---|
| Autenticación M2M | Intercambio de tokens con credenciales de cliente |
| Permisos (JS) | Comprobar permisos con @auris/js |
| Permisos (React) | usePermissions y PermissionGate |
| Permisos (Next.js) | Helpers de servidor requirePermission y checkPermission |
| Comprobaciones FGA | Comprobaciones de tuplas de Autorización Detallada |
| API de Gestión | Gestión de usuarios/roles/organizaciones del lado del servidor mediante M2M |
| Verificación de Webhooks | Verificación de firmas HMAC-SHA256 |
| Verificación JWT | Verificación local de tokens usando JWKS |
Cada tema incluye un ejemplo de código funcional con las credenciales de tu aplicación rellenadas previamente.
Herramienta CLI
La página de referencia de la Herramienta CLI documenta la interfaz de línea de comandos auris para gestionar tu tenant desde un terminal. Accede a la referencia en Consola → Desarrollador → CLI.
Comandos Disponibles
| Comando | Descripción |
|---|---|
auris init | Inicializa un proyecto con configuración Auris |
auris login | Autenticarse con tu tenant Auris |
auris users list | Listar usuarios del tenant |
auris users create | Crear un nuevo usuario |
auris roles list | Listar roles |
auris roles create | Crear un nuevo rol |
auris orgs list | Listar organizaciones |
auris apps list | Listar aplicaciones |
auris logs tail | Transmitir logs de auditoría en tiempo real |
auris actions list | Listar reglas del Motor de Acciones |
auris fga check | Ejecutar una comprobación FGA desde la línea de comandos |
auris import | Importar usuarios desde CSV/JSON |
auris export | Exportar usuarios a CSV/JSON |
Instalación
npm install -g @auris/cliAutenticación
El CLI usa el mismo flujo OAuth2 que la Consola. Al ejecutar auris login se abre una ventana del navegador para la autenticación y se almacena el token localmente.
Resumen de SDKs
La página Resumen de SDKs compara características entre los tres paquetes SDK. Accede en Consola → Desarrollador → SDKs.
Comparación de Características
| Característica | @auris/js | @auris/react | @auris/nextjs |
|---|---|---|---|
| Login OAuth2 + PKCE | Sí | Sí | Sí |
| Login con magic link | Sí | Sí | Sí |
| Login social | Sí | Sí | Sí |
| Gestión de tokens | Sí | Sí | Sí |
| Auto-refresh | Sí | Sí | Sí |
| Comprobaciones de permisos | Sí | Sí (hooks) | Sí (servidor) |
| Comprobaciones FGA | Sí | Sí (hooks) | Sí (servidor) |
| API de Gestión (M2M) | Sí | No | Sí (servidor) |
| Verificación de webhooks | Sí | No | No |
| Verificación JWT local | Sí | No | Sí |
| Provider de React | No | Sí | Sí |
| Hooks de React | No | Sí | Sí |
| Helpers de servidor | No | No | Sí |
| Middleware Edge | No | No | Sí |
Componente PermissionGate | No | Sí | Sí |
Componente AuthGuard | No | Sí | Sí |
Detalles de los Paquetes
| Paquete | Dependencias | Tamaño del bundle | Entornos |
|---|---|---|---|
@auris/js | Sin dependencias | ~8 KB comprimido | Navegador, Node.js, Edge |
@auris/react | Depende de @auris/js | ~12 KB comprimido | Navegador (React 18+) |
@auris/nextjs | Depende de @auris/react | ~15 KB comprimido | Navegador + Servidor + Edge (Next.js 13+) |
Documentación para Desarrolladores
La página de Documentación para Desarrolladores proporciona guías de referencia inline organizadas en secciones desplegables. Accede en Consola → Desarrollador → Docs.
Secciones de las Guías
| Sección | Temas Cubiertos |
|---|---|
| Primeros Pasos | Instalación, configuración básica, primer inicio de sesión |
| Autenticación | Métodos de login, manejo de tokens, logout, gestión de sesiones |
| Autorización | Comprobaciones de permisos RBAC, integración FGA, claims personalizados |
| Webhooks | Configuración de endpoints, verificación de firmas, tipos de eventos |
| Lado del Servidor | Tokens M2M, API de gestión, renderizado del lado del servidor |
| OIDC | Documento de descubrimiento, JWKS, endpoints estándar |
Cada sección incluye:
- Texto explicativo conciso
- Bloques de código con resaltado de sintaxis
- Botones Copiar en todos los bloques de código
- Enlaces rápidos a la documentación completa para lectura más profunda
La página de Documentación para Desarrolladores está diseñada como referencia rápida que permanece dentro de la Consola, evitando cambios de contexto a documentación externa para tareas comunes.
Guías Relacionadas
- SDKs — Documentación completa de los SDKs
- Referencia de la API — Documentación completa de los endpoints de la API
- Aplicaciones — Configurar las aplicaciones usadas en Quickstarts
- Tutorial de Quickstarts — Tutorial completo de primeros pasos