API REST
Una API de extracción de documentos que devuelve un JSON limpio.
Envíe un PDF, una imagen o un archivo de oficina con su clave API y reciba campos tipados, con el tipo de documento detectado y una puntuación de confianza. En modo síncrono, o deje que DocuSense llame a su webhook cuando el documento esté listo.
La API está disponible en todos los planes, incluido el gratuito (facturas y campos personalizados). Comprobantes fiscales y recibos de nómina desde el plan Pro.
Desarrollar su propia lectura de documentos lleva meses
Cada proveedor, empleador y banco usa su propio formato, y las plantillas fallan al primer cambio.
Un OCR por sí solo devuelve texto, no los campos, tipos y totales que necesita su aplicación.
Los resultados dudosos deben detectarse antes de llegar a su base de datos.
Cómo funciona
Crear una clave
Cree una clave API en el panel con solo los permisos necesarios: lectura, escritura o eliminación.
Enviar el archivo
Envíe el archivo en base64 dentro de un JSON con documentType AUTO, o el tipo esperado. Los lotes aceptan un ZIP o un PDF de varias páginas.
Recibir el JSON
Obtenga el tipo de documento, una puntuación de confianza, los campos extraídos, el resultado de los controles y un indicador de revisión.
Automatizar
Use tareas asíncronas, lotes y webhooks firmados para reaccionar en cuanto se procese un documento.
Tipos de documentos disponibles por la API
El mismo endpoint gestiona todos los tipos; AUTO los detecta por usted.
Todos los planes
- Facturas
- Campos personalizados en cualquier documento
Plan Pro y superiores
- Extractos bancarios
- T4, W-2, P60, P45
- Registro de empleo canadiense (ROE)
- Recibos de nómina canadienses y europeos
Plan Ultra y superiores
- RL-1 de Quebec
- Aviso fiscal francés (avis d'imposition)
- Contratos
Una respuesta, tal como la recibe su código
Llamada síncrona sobre una factura (datos extraídos abreviados para su lectura).
{
"success": true,
"data": {
"id": "8f3c2b1e-4a5d-4c6e-9f70-1a2b3c4d5e6f",
"status": "COMPLETED",
"documentType": "INVOICE",
"classificationConfidence": 0.98,
"reviewRequired": false,
"checkStatus": "ok",
"extractedData": {
"invoiceNumber": "INV-0425",
"vendor": {
"name": "Example Supplies Inc."
},
"total": 1195.74,
"currency": "CAD"
}
}
}Formatos y límites
Lo que puede enviar
- PDF, PNG, JPG, WEBP, Word (.docx), Excel (.xlsx), CSV
- Un archivo en base64 dentro de un JSON; los lotes como envío binario (ZIP o PDF)
- Hasta 10 MB por archivo; archivos ZIP por lotes
Lo que recibe
- JSON tipado con tipo de documento y puntuación de confianza
- Exportación CSV de un documento
- Webhooks firmados con HMAC-SHA256 y marca de tiempo
Conviene saber
- Los límites de frecuencia y la cuota mensual de páginas dependen del plan; cada respuesta indica los límites en sus encabezados.
- Guarde su clave en su servidor: nunca en un navegador, una aplicación móvil o un repositorio público.
Pensada para producción
- Las claves API se guardan cifradas con hash, pueden limitarse a lectura, escritura o eliminación, y dejan de funcionar al revocarlas.
- Los webhooks se firman con una marca de tiempo: su servidor puede rechazar llamadas falsificadas o repetidas.
- Los archivos originales se eliminan tras el procesamiento y los identificadores como el número de seguro social se enmascaran.
Preguntas frecuentes
¿La API es síncrona o asíncrona?
Ambas. Una llamada síncrona devuelve los datos extraídos en la respuesta. Para documentos largos o lotes, use tareas asíncronas y un webhook, o consulte la tarea.
¿Qué lenguajes cubren los ejemplos de código?
cURL, Python, Node.js, PHP, Ruby, Go, Java, C# (.NET), VB.NET, C, C++, Kotlin, Swift, Dart, Rust y PowerShell, generados a partir de la especificación OpenAPI.
¿Cómo sé si un resultado es fiable?
Cada respuesta incluye el tipo detectado, una puntuación de confianza de clasificación, el resultado de los controles automáticos y un indicador reviewRequired. Envíe los documentos señalados a revisión humana.
¿Existe una especificación OpenAPI?
Sí. El archivo OpenAPI completo es público y se importa en Postman o en cualquier herramienta OpenAPI.
¿Puedo probarla gratis?
Sí. El plan gratuito incluye 50 páginas al mes y 100 páginas de bienvenida, para facturas y campos personalizados por la API.
Integre la extracción de documentos esta semana.
Cree una cuenta gratuita, genere una clave API y haga su primera llamada en minutos.