Bienvenido a la Documentación de Docmind

Aquí encontrarás la documentación completa de todas las APIs de Docmind. La API te permite extraer campos de documentos, gestionar habilidades, catálogos, usuarios y mucho más.

Primeros pasos

1. Crear tu API Key: visita la sección Autenticación.
2. Realizar la primera llamada: envía archivos a POST /v1/extractions.
3. Obtener los datos extraídos: con GET /v1/extractions/{id} podrás ver los resultados.

API Pública (v1)

Endpoints disponibles para integraciones externas usando API Key:

• Extracciones — Crear, listar y consultar extracciones
• Habilidades — Listar y crear habilidades, incluidos campos de catálogo, matching agrupado y valores excluidos
• Catálogos — Gestionar catálogos de datos maestros
• Organizaciones y suscripciones — Alta de tenants y activación de suscripciones (admin global)

Guía de integración

Si vas a integrar Docmind desde otro producto, el recorrido completo —crear el tenant, activarle la suscripción, definir la habilidad, enviar documentos, revisarlos en el iframe y recoger los datos— está en el documento INTEGRACION_API.md del repositorio.

Embed / Iframe

Integra el visor de extracciones en tu aplicación:

• API de Embed — Tokens, eventos postMessage y ejemplo completo

API Interna

Endpoints usados por la aplicación de Docmind (autenticación JWT):

• Autenticación interna — Login, logout, user-info
• Extracciones internas — CRUD completo con JWT
• Habilidades internas — CRUD + aprendizaje de campos
• Campos de extracción — Actualizar campos extraídos
• Reglas de validación — CRUD de reglas por habilidad
• Tipos de documento — CRUD de tipos
• Catálogos internos — CRUD completo de catálogos
• Usuarios — Gestión de usuarios del cliente
• Roles — Listar roles del sistema
• API Keys — Crear, listar y revocar API Keys
• Licencias — Consultar licencia y consumo
• Reportes avanzados — Métricas y estadísticas
• Skills Market — Marketplace de habilidades
• Entrenamientos — Historial de entrenamientos
• Multi-Tenant — Gestión de clientes por usuario
• Cleanup — Limpieza de extracciones

Administración Global

Endpoints exclusivos para administradores globales:

• Admin Usuarios — Gestión global de usuarios
• Admin Clientes — Gestión de clientes y licencias
• Admin Dashboard — Métricas globales