Qué necesitas
- Una cuenta en Matil — regístrate aquí
- Una API key
- Un deployment ID
Obtener tu API key
Abre el dashboard
Inicia sesión en el Dashboard de Matil y ve a Settings > API Keys.
Crea una nueva clave
Haz clic en Create New Key. Dale un nombre descriptivo (por ejemplo, “Desarrollo” o “Producción”).
Guarda tu API key en una varíable de entorno. Nunca la escribas directamente en tu código fuente ni la subas a control de versiones.
Encontrar tu deployment ID
Ve a Deployments en el dashboard. Selecciona el deployment que quieras usar y copia su ID. Un deployment ID es un UUID como:01234567-89ab-cdef-0123-456789abcdef
Hacer tu primera petición
Envía un documento a tu deployment:Entender la respuesta
Una respuesta exitosa se ve así:| Campo | Descripción |
|---|---|
entry_id | ID único de este resultado. Úsalo para consultar o corregir la entrada. |
resource_type | Siempre "structure". |
resource_id | La estructura utilizada para la extracción. |
resource_version_number | La versión de la estructura aplicada. |
data | Los datos extraídos, estructurados como JSON. |
errors | Errores de validación, si los hay. null cuando todo es correcto. |
status | completed, completed_with_errors o failed. |
time_ms | Tiempo de procesamiento en milisegundos. |
price | Coste de esta petición. |
Siguientes pasos
Deployments
Entiende cómo los deployments conectan estructuras con llamadas API.
Formatos de documento
Conoce todas las formas de enviar documentos a Matil.
Modos de procesamiento
Procesamiento síncrono, asíncrono y por lotes.
Manejo de errores
Gestiona los errores correctamente en tu integración.