Analizar documento
Extracto → Analizar documento
El Analizar documento API extrae datos estructurados de un PDF utilizando una plantilla que usted crea en el PDF4me panel. Tú envías docContent (opcional; si se omite, el documento se recupera mediante docName), docName, TemplateId (GUID) o TemplateName, ParseId (GUID), y opcionalmente async. El API devoluciones JSON con datos analizados (tipo de documento, número de páginas, campos extraídos). Utilice la herramienta de prueba que aparece a continuación para comprobarlo; encontrará más detalles en las secciones siguientes.
Prueba el documento Analizar API
:::nota Referencia rápida
Punto final: POST /api/v2/ParseDocument · Requerido: api-key, docName, TemplateId (o TemplateName), ParseId
:::
Utiliza el formulario a continuación para enviar tu solicitud API llave, PDF (Base64 o referenciado por docName), ID o nombre de la plantilla e ID de análisis. La respuesta es JSON con datos de documento analizados. No se requiere código, complete los campos y haga clic. Enviar solicitud.
Descripción general, parámetros y casos de uso
- Overview
- Parameters
- Use cases
¿Qué es Parse Document?
Este punto final extrae datos estructurados de un PDF usando un plantilla de análisis tú creas en el PDF4me panel de control. Usted proporciona el PDF (docContent opcional, si se omite el documento se recupera por docName), docName, TemplateId (GUID) o TemplateName, y ParseId (GUID). El API devoluciones JSON con el tipo de documento, el número de páginas y los campos extraídos en función de las áreas de captura y las claves de su plantilla.
Características principales
- Basado en plantillas: Crea una plantilla en el panel de control: sube un ejemplo PDF, dibujar áreas de captura, configurar claves y expresiones regulares.
- TemplateId o TemplateName: Utilice la plantilla GUID o el nombre del panel de control.
- ParseId: Único GUID por operación de análisis (generar en el lado del cliente o usar API-proporcionó).
- Salida estructurada: JSON con tipo de documento, número de páginas y datos estructurados extraídos.
Obtención de ID de plantilla y análisis
- Acceso PDF4me Panel: Ve al analizar documento página.
- Crear una plantilla: Haz clic en "Agregar" e introduce un nombre para la plantilla, luego guarda.
- Configurar plantilla: Subir una plantilla PDF, dibujar áreas de captura, configurar claves y expresiones regulares, probar el análisis y guardar.
- Obtener ID de plantilla: Copiar el único GUID para su plantilla (o utilice TemplateName).
- Generar ID de análisis: Crea un único GUID para cada operación de análisis (del lado del cliente o mediante una herramienta).
Utilizar cuando se tienen tipos de documentos recurrentes (facturas, formularios) y se necesita una extracción estructurada. Combinar con Documento clasificado para enrutar por tipo y luego analizar con la plantilla correcta.
API parámetros
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| api-key | cadena | Sí | Su PDF4me API llave, Base64 codificado. Consíguelo desde el panel. |
| docContent | base64 | No | PDF contenido del archivo (Base64). Si se omite, el documento se recupera mediante docName. |
| docName | cadena | Sí | PDF Nombre del archivo con extensión .pdf. |
| TemplateId | cadena | Sí* | Único GUID para la plantilla de análisis (desde el panel de control). *Usar TemplateId o TemplateName. |
| TemplateName | cadena | No | Nombre de la plantilla (alternativa a TemplateId). |
| ParseId | cadena | Sí | Único GUID para esta operación de análisis. |
| async | booleano | No | Habilitar el procesamiento asíncrono. |
Cuándo usar Parse Document
- Facturas y formularios: Extraer campos estructurados (importe, fecha, proveedor) de tipos de documentos recurrentes.
- Automatización de documentos: Utilice plantillas para extraer datos de fuentes similares PDFs en CRM, ERPo bases de datos.
- Cumplimiento: Extraer campos clave para su retención o auditoría a partir de documentos estandarizados.
Para ver esquemas de solicitud/respuesta y ejemplos de código, consulte Analizar documento en el PDF4me API documentos.
Requisitos previos
Antes de utilizar este punto final, asegúrese de tener:
- Un válido PDF4me API llave (Consigue tu API Llave)
- A PDF documento en Base64 formato o público URL a un PDF archivo
- A Plantilla de análisis creado en tu PDF4me panel (Crear plantilla de análisis)
- Necesitas el ID de plantilla (GUID) o Nombre de la plantilla desde su plantilla de análisis
- A ID de análisis (GUID) para la operación de análisis
Formato de respuesta
El API devuelve un JSON Respuesta con datos del documento analizados, incluyendo el tipo de documento, el número de páginas y la información estructurada extraída.