Agregar campos de formulario a PDF - API de formularios interactivos

PDF4me Agregar campos de formulario al PDF le permite agregar campos de formulario interactivos a PDF documentos. Este API procesos de servicio PDF archivos y agrega campos de formulario (cuadros de texto y casillas de verificación) en posiciones específicas en páginas específicas. API recibe PDF parámetros de contenido y campos de formulario a través de REST API llamadas, utilizando Base64 Codificación para una transmisión segura. Con soporte para posicionamiento flexible, tipos de campos personalizados y segmentación de páginas, esta solución es ideal para la automatización de documentos y la interactividad. PDF flujos de trabajo de desarrollo.

Entradas de blog relacionadas

Aún no hay ninguna entrada de blog sobre esta función; estará disponible próximamente.

Mientras tanto, echa un vistazo al blog de PDF4me para encontrar tutoriales y flujos de trabajo para todas las plataformas.

Visita el blog →

Autenticando su solicitud de API

Para acceder al PDF4me REST APICada solicitud debe incluir las credenciales de autenticación adecuadas. La autenticación garantiza una comunicación segura y valida su identidad como usuario autorizado del sistema. REST API.

Get your api Key

Características principales

• Tipos de campos de formulario: Agregar campos de formulario TextBox y CheckBox a PDF documentos
• Posicionamiento preciso: Controla la ubicación del campo con coordenadas X e Y exactas.
• Tamaño de campo personalizado: Ajustar las dimensiones de los campos del formulario para que coincidan con los requisitos de diseño.
• Segmentación de páginas flexibleAplicar campos de formulario a páginas específicas o a documentos completos.
• Valores iniciales: Establecer valores predeterminados para los campos del formulario
• Base64 Codificación: Transmisión segura del contenido de los archivos mediante Base64 codificación
• Simple API Integración: RESTful API diseñado para automatización PDF flujos de trabajo para la creación de formularios

Punto final de la API REST

El PDF4me REST API utiliza estándar HTTP métodos para interactuar con los recursos. Todas las operaciones de adición de campos de formulario se realizan a través de un único punto final:

• Método: POST
• Punto final: /api/v2/AddFormField

Parámetros de la API REST

Lista completa de parámetros para la función Agregar campos de formulario a PDF REST APILos parámetros están organizados por categoría para una mejor comprensión e implementación.

Importante: Los parámetros marcados con un asterisco (*) son obligatorios y deben proporcionarse para la API para que funcione correctamente.

Parámetros requeridos

Parámetro	Tipo	Descripción	Ejemplo
docContent*	Base64	El contenido de la entrada PDF archivo codificado en Base64	JVBERi...
Nombre del documento*	String	Fuente PDF Nombre del archivo con extensión .pdf	output.pdf
valor inicial*	String	Valor inicial para el campo del formulario	New input text
posiciónX*	Integer	Posición X del campo del formulario en la página	300
posiciónY*	Integer	Posición Y del campo del formulario en la página	300
nombre del campo*	String	Nombre del campo del formulario	Input Field Name
Tamaño*	Integer	Tamaño del campo del formulario	4
páginas*	String	Opciones de página: "1" para la página 1, "1,3,5" para páginas específicas, "2-5" para un rango de páginas, "1,3,7-10" para páginas mixtas, "1-" para páginas desde la 1 hasta el final.	1
Tipo de campo de formulario*	String	Tipo de campo del formulario: Cuadro de texto o Caja	TextBox

Parámetros opcionales

Parámetro	Tipo	Descripción	Ejemplo
asíncrono	Boolean	Habilitar el procesamiento asíncrono. Cuando true, el API devuelve un estado 202 y proporciona una encuesta URL en el encabezado de Ubicación	true

Producción

El PDF4me Agregar campos de formulario al PDF REST API devuelve diferentes respuestas según el modo de procesamiento. API devuelve el PDF como datos binarios para procesamiento síncrono o proporciona un sondeo URL para procesamiento asíncrono.

Success Response

Procesamiento síncrono (predeterminado)

Cuando async no está configurado o está configurado false, el API procesa la solicitud inmediatamente:

Código de estado: 200 OK

Tipo de contenido: application/pdf o application/octet-stream

Cuerpo de la respuesta:

El API devuelve el PDF archivo directamente como datos binarios (no JSON).

Cómo usarlo:

1. El cuerpo de la respuesta contiene el binario PDF datos
2. Guarda el contenido de la respuesta directamente como un archivo. PDF archivo
3. No Base64 Se requiere decodificación para las respuestas binarias.

Ejemplo (JavaScript):

const response = await fetch(url, options);
const pdfBlob = await response.blob();
// Save or process pdfBlob directly

Asynchronous Processing

Procesamiento asíncrono

Cuando async: true está establecido, el API procesa la solicitud de forma asíncrona:

Código de estado: 202 Accepted

Encabezados de respuesta:

Location: https://api.pdf4me.com/api/v2/AddFormField/poll/12345-abcde-67890

Proceso de votación:

1. Extraer el Location encabezado de la respuesta 202
2. Encuesta la URL usando GET solicitudes
3. Continúe realizando encuestas hasta que reciba una 200 OK estado
4. La respuesta final contiene el binario PDF datos

Ejemplo de encuesta:

// Initial request returns 202 with Location header
const response = await fetch(url, options);
const location = response.headers.get('Location');

// Poll until complete
while (true) {
  const pollResponse = await fetch(location, { headers: { 'Authorization': 'Basic ' + apiKey } });
  if (pollResponse.status === 200) {
    const pdfBlob = await pollResponse.blob();
    // Process binary PDF
    break;
  }
  await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}

Error Responses

Respuestas de error

Código de estado	Descripción	Ejemplo de respuesta
400 Bad Request	Parámetros de solicitud no válidos o campos obligatorios faltantes.	{"error": "Missing required parameter: fieldName"}
401 Unauthorized	Inválido o faltante API llave	{"error": "Unauthorized"}
500 Internal Server Error	Error del servidor durante el procesamiento	{"error": "Internal server error"}

Response Format Details

Comprender la respuesta

• Síncrono (200): Devuelve binario PDF datos directamente
• Asíncrono (202)Devuelve el encabezado Location para sondeo; la respuesta final es binaria. PDF
• No JSON Envoltorio: El API devoluciones PDF como binario, no envuelto en JSON con Base64 codificación

Ejemplo de solicitud

Encabezamiento

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Nota: El API La clave debe ser Base64 codificado. Obtenga su API clave del PDF4me Panel

Carga útil

{
  "docContent": "Please put PDF base64 content",
  "docName": "output.pdf",
  "initialValue": "input text",
  "positionX": 300,
  "positionY": 300,
  "fieldName": "Input Field Name",
  "Size": 4,
  "pages": "1",
  "formFieldType": "TextBox"
}

Ejemplos de código

El PDF4me Agregar campos de formulario a un PDF REST API Proporciona ejemplos de código en varios lenguajes de programación. Elija el lenguaje que mejor se adapte a su entorno de desarrollo:

C#

C# (CSharp) Muestra

Completo C# implementación para agregar campos de formulario a PDF:

View C# Sample

Java

Java Muestra

Java Implementación con manejo completo de errores y procesamiento de respuestas:

View Java Sample

JavaScript

JavaScript Muestra

Node.js y compatible con navegadores JavaScript implementación:

View JavaScript Sample

Python

Python Muestra

Python implementación con la biblioteca requests y JSON manejo:

View Python Sample

Salesforce

Salesforce Muestra

Salesforce Apex implementación para CRM integración:

View Salesforce Sample

n8n

n8n Muestra

n8n Implementación de flujos de trabajo para la automatización:

View n8n Sample

Google Script

Google Apps Script Muestra

Google Apps Script implementación para Google Workspace integración:

View Google Script Sample

AWS Lambda

AWS Lambda Muestra

Sin servidor AWS Lambda Implementación de la función:

View AWS Lambda Sample

Funcionalidades de creación de campos de formulario

Tipos de campos de formulario

• Campos de cuadro de texto: Crear campos de entrada de texto para la introducción de datos del usuario y la cumplimentación de formularios.
• Campos de casilla de verificación: Agregar elementos de casilla de verificación para opciones de selección y confirmación.
• Tallas personalizadas: Ajustar las dimensiones del campo para que coincidan con los requisitos de diseño y las necesidades de contenido.
• Resultados profesionalesCreación de campos de formulario de alta calidad con funcionalidad precisa.
• Procesamiento avanzado: Compatibilidad con diseños de formularios y disposiciones de campos complejos

Posicionamiento y diseño

• Coordenadas precisas: Controlar la ubicación del campo con valores de posición X e Y exactos.
• Posicionamiento flexible: Compatibilidad con cualquier posición de página y disposición de campos.
• Segmentación de páginasAplicar campos de formulario a páginas específicas o a documentos completos.
• Tallas personalizadasDimensiones de campo ajustables para un diseño de forma óptimo
• Diseño profesionalUbicación uniforme de los campos del formulario en todas las páginas de destino.

Características avanzadas

• Valores iniciales: Establezca valores predeterminados para los campos para mejorar la experiencia del usuario.
• Nomenclatura de campos: Nombres de campos personalizados para la recopilación y el procesamiento de datos de formularios
• Creación profesionalGeneración de campos de formulario de alta calidad con funcionalidad clara.
• Opciones flexiblesParámetros de campo de formulario personalizables para requisitos específicos

Casos de uso y aplicaciones en la industria

Legal & Professional Services

Casos de uso de servicios legales y profesionales

• Formularios de contrato: Agregar campos de formulario a contratos y acuerdos para firmas digitales
• Documentación legal: Crear formularios interactivos para el procesamiento de documentos legales
• Formularios de cumplimiento: Elaborar formularios para el cumplimiento normativo y la documentación.
• Admisión de clientes: Crear formularios de admisión de clientes para servicios legales

Healthcare & Medical

Casos de uso en el sector sanitario y médico

• Formularios del paciente: Crear formularios interactivos de admisión de pacientes e historial médico.
• Documentación médica: Crear formularios para registros y documentación médica
• Reclamaciones de seguros: Diseñar formularios para la tramitación de reclamaciones de seguros
• Formularios de consentimiento: Crear formularios de consentimiento y autorización para procedimientos médicos

Finance & Banking

Casos de uso en finanzas y banca

• Aplicaciones financieras: Crear formularios de solicitud de préstamos y créditos
• Apertura de cuenta: Crear formularios para la apertura de cuentas y los procesos KYC
• Formularios de transacción: Diseñar formularios para transacciones y procesamiento financieros
• Documentación de cumplimientoCrear formularios para la presentación de informes de cumplimiento normativo

Human Resources

Casos de uso de recursos humanos

• Procesamiento de solicitudes: Crear formularios de solicitud para solicitudes de empleo y registros.
• Incorporación de empleados: Crear formularios para la incorporación y documentación de empleados
• Creación de encuestas: Diseñar encuestas y cuestionarios interactivos en PDF formato
• Evaluaciones de desempeño: Crear formularios para la evaluación del desempeño y la retroalimentación

Business & Enterprise

Casos de uso para empresas y negocios

• Automatización de documentos: Crear formularios interactivos para la recopilación y el procesamiento de datos.
• Recopilación de datos: Crear formularios para recopilar información y comentarios de los clientes.
• Documentos interactivos: Agregar campos de formulario a los existentes PDFs para una mayor participación del usuario
• Automatización de procesos empresariales: Crear formularios para flujos de trabajo empresariales automatizados y entrada de datos

Obtén ayuda

Get Your API KeyAPI SamplesGetting Started