Documentación de la API de Console

La API de Solução42 Console es una API RESTful que te permite integrar gestión de usuarios multi-tenant, autenticación y autorización en tus aplicaciones.

Inicio RápidoReferencia de la API

Qué Puedes Construir

🔐 Autenticación

Implementa autenticación basada en JWT con renovación de tokens, SSO y soporte para 2FA.

👥 Gestión de Usuarios

Crea, invita y gestiona usuarios de forma programática en toda tu organización.

🔒 Autorización

Construye control de acceso basado en roles con grupos y permisos.

🏢 Multi-Tenancy

Maneja múltiples clientes con aislamiento completo de datos.

Características de la API

Característica	Detalles
Protocolo	REST sobre HTTPS
Autenticación	JWT (HS256) con tokens de actualización
Formato de Respuesta	JSON
URL Base	https://api.console.solucao42.com.br
Versión de API	v1 (prefijo: /v1/)

Ejemplo Rápido

Así de fácil es autenticarse y obtener usuarios:

// 1. Iniciar sesión para obtener tokens
const response = await fetch('https://api.console.solucao42.com.br/v1/auth/login', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    company_slug: 'acme-corp',
    email: '[email protected]',
    password: 'your-secure-password'
  })
});

const { access_token } = await response.json();

// 2. Usar el token para obtener usuarios
const users = await fetch('https://api.console.solucao42.com.br/v1/users', {
  headers: { 'Authorization': `Bearer ${access_token}` }
});

console.log(await users.json());
// { total: 25, quantity: 20, records: [...] }

Conceptos Básicos

Antes de comenzar, comprende estos conceptos clave:

Concepto	Descripción
Access Token	JWT de corta duración (10 min) para solicitudes a la API
Refresh Token	Token de larga duración (7 días) para renovar access tokens
Compañía	Tenant raíz que representa una organización cliente
Grupo	Colección de usuarios con permisos específicos
Contexto	Alcance actual de la compañía en el JWT

Convenciones de la API

Endpoints REST

Método	Propósito	Ejemplo
GET /resources	Listar todos	GET /v1/users
GET /resources/:id	Obtener uno	GET /v1/users/123
POST /resources	Crear	POST /v1/users/invite
PATCH /resources/:id	Actualizar	PATCH /v1/users/123
DELETE /resources/:id	Eliminar	DELETE /v1/users/123

Paginación

Todos los endpoints de lista soportan paginación:

GET /v1/users?page=2&per_page=50&sort_by=-created_at

Formato de respuesta:

{
  "total": 150,
  "quantity": 20,
  "records": [...]
}

Manejo de Errores

Estado	Significado
200	Éxito
201	Creado
400	Solicitud incorrecta
401	No autenticado
403	No autorizado
404	No encontrado
422	Error de validación
429	Límite de tasa excedido

Próximos Pasos

1. Inicio Rápido - Haz tu primera solicitud a la API
2. Flujos de Autenticación - Comprende los tokens JWT
3. Referencia de la API - Explora todos los endpoints
4. Guías de Integración - Integra autenticación en tu aplicación

Para Usuarios del Producto

¿Usas la interfaz web de Console? Consulta la Documentación del Producto para guías de interfaz y tutoriales.

¿Necesitas Ayuda?

• 📧 Email: [email protected]
• 📚 GitHub: Proyectos de Ejemplo
• 💬 Discord: Únete a nuestra comunidad de desarrolladores