Agregar número de página a PDF - Paginación API
PDF4me Agregar número de página a PDF le permite agregar números de página personalizables a PDF documentos con control sobre la posición, el formato y el estilo. API procesos de servicio PDF archivos y agrega números de página usando marcadores de posición de formato donde # representa el número de página actual y {1} representa el número total de páginas. API recibe PDF contenido a través de REST API llamadas, utilizando Base64 Codificación para transmisión segura. Esta solución es ideal para la organización de documentos, documentación legal, trabajos académicos y empresas. PDF flujos de trabajo.
Autenticando su API Pedido
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.
Características principales
- Formato flexible: Elija entre varios formatos de numeración de páginas usando
#para la página actual y{1}para el total de páginas (por ejemplo, "# de 1", "Página #") - Posicionamiento precisoControla la alineación horizontal y vertical con precisión milimétrica.
- Estilo personalizadoAjusta el tamaño de la fuente, la negrita, la cursiva y otras opciones de formato de texto.
- Control de márgenes: Establezca márgenes precisos en milímetros para una colocación óptima.
- Saltar la primera páginaOpción para excluir los números de página de la primera página.
- Resultados profesionales: Crear una numeración de páginas coherente y profesional en todos los documentos.
REST API Punto final
El PDF4me REST API utiliza estándar HTTP métodos para interactuar con los recursos. Todas las operaciones de adición de números de página se realizan a través de un único punto final:
- Método: CORREO
- Punto final:
/api/v2/AddPageNumber
REST API Parámetros
Lista completa de parámetros para Agregar número de página 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 |
|---|---|---|---|
| Nombre del documento* | Cadena | Producción PDF Nombre del archivo con extensión .pdf | output.pdf |
| docContent* | Base64 | PDF contenido del archivo codificado en Base64 | JVBERi... |
| Formato de número de página* | Cadena | Formato de número de página. Utilizar # para el número de página actual, {1} para el total de páginas. Ejemplos: "# de 1", "Página #", "# / 1" | # of {1} |
| alinearX* | Cadena | Alineación horizontal: izquierda, centro, o bien | right |
| alinearY* | Cadena | Alineación vertical: arriba, medio, o abajo | bottom |
Parámetros opcionales
| Parámetro | Tipo | Descripción | Ejemplo |
|---|---|---|---|
| margenXinMM | Entero | Margen horizontal desde el borde en milímetros (0-100) | 2 |
| margenEnMM | Entero | Margen vertical desde el borde en milímetros (0-100) | 2 |
| tamaño de fuente | Entero | Tamaño de fuente para los números de página (8-72) | 12 |
| Bola de hielo | Booleano | Mostrar los números de página en negrita (verdadero) o en formato normal (falso). | true |
| es cursiva | Booleano | Mostrar los números de página en cursiva (verdadero) o en formato normal (falso). | false |
| skipFirstPage | Booleano | Omitir la numeración en la primera página (verdadero) o incluirla (falso) | false |
| asíncrono | Booleano | Habilitar el procesamiento asíncrono. Cuando true, el API devuelve un estado 202 y proporciona una encuesta URL en el Location encabezado | true |
Marcadores de posición para el formato de números de página
El pageNumberFormat El parámetro utiliza los siguientes marcadores de posición:
#- Sustituido por el número de página actual (1, 2, 3, etc.){1}- Reemplazado por el número total de páginas
Ejemplos de formato:
"# of {1}"→ Muestra "1 de 10", "2 de 10", "3 de 10", etc."Page #"→ Muestra "Página 1", "Página 2", "Página 3", etc."# / {1}"→ Muestra "1 / 10", "2 / 10", "3 / 10", etc."- # -"→ Muestra "- 1 -", "- 2 -", "- 3 -", etc."[#/{1}]"→ Muestra "[1/10]", "[2/10]", "[3/10]", etc."(#)"→ Muestra "(1)", "(2)", "(3)", etc."#"→ Muestra solo el número de página: "1", "2", "3", etc.
Producción
El PDF4me Agregar número de página a PDF REST API devuelve diferentes respuestas según el modo de procesamiento. API devuelve el PDF como un Base64cadena codificada en JSON formato, no como datos binarios.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
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
Content-Type: application/json
Cuerpo de la respuesta:
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg=="
}
Campos de respuesta:
- Nombre del documento (cadena): La salida PDF Nombre del archivo
- docContent (cadena): El PDF archivo con números de página añadidos, codificado como Base64 cadena
Cómo usarlo:
- Extraer el
docContentcampo del JSON respuesta - Decodifica el Base64 cadena para obtener el binario PDF datos
- Guardar o procesar el PDF Archivo según sea necesario
Ejemplo (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const pdfBytes = atob(data.docContent); // Decode Base64
// Save or process pdfBytes
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/AddPageNumber/poll/12345-abcde-67890
Proceso de votación:
- Extraer el
Locationencabezado de la respuesta 202 - Encuesta la URL usando GET solicitudes
- Continúe realizando encuestas hasta que reciba una 200 OK estado
- La respuesta final contiene lo mismo JSON formato con
docNameydocContent(Base64)
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 data = await pollResponse.json();
// Process data.docContent (Base64 PDF)
break;
}
await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}
Respuestas de error
El API devuelve estándar HTTP Códigos de error con detalles del error:
- Parámetros de solicitud no válidos
- Faltan campos obligatorios (
docContent,Nombre del documento,Formato de número de página,alinearX,alinearY) - Inválido Base64 codificación en
docContent - Valores de alineación no válidos (deben ser "izquierda", "centro" o "derecha" para alignX; "superior", "medio" o "inferior" para alignY).
- Tamaño de fuente no válido (debe estar entre 8 y 72).
- Valores de margen no válidos (deben ser números enteros entre 0 y 100).
- Inválido o faltante API llave
- API La llave no funciona correctamente. Base64 codificado en Authorization encabezado
- Desaparecido
Autorización: Básicaencabezado
- Error de procesamiento del servidor
- PDF fallo de procesamiento
- Error al agregar el número de página
Formato de respuesta de error:
{
"error": "Error message describing what went wrong"
}
Detalles del formato de respuesta
Importante: El API siempre regresa JSON, nunca binario PDF datos directamente.
Estructura de respuesta:
{
"docName": "string", // Output PDF filename
"docContent": "string" // Base64-encoded PDF content
}
Content-Type Encabezado:
- Éxito:
application/json - El PDF está incrustado como un Base64 cadena dentro de la JSON respuesta
Por qué Base64¿
- JSON-Codificación segura para datos binarios
- Fácil de transmitir HTTP
- Compatible con todos los lenguajes de programación.
- Se puede integrar directamente en JSON sin escapar de los problemas
Decodificación Base64 a PDF:
JavaScript/Node.js:
const base64 = response.docContent;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64').toString('binary'); // Node.js
Python:
import base64
pdf_bytes = base64.b64decode(response['docContent'])
with open('output.pdf', 'wb') as f:
f.write(pdf_bytes)
C#:
byte[] pdfBytes = Convert.FromBase64String(response.docContent);
File.WriteAllBytes("output.pdf", pdfBytes);
Ejemplo de solicitud
Encabezamiento
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Nota:
- Consigue tu API clave del PDF4me Panel
- El API La clave debe ser Base64 codificado y prefijado con "Basic" en el Authorization encabezado
- Ejemplo: Si su API La clave es
abc123, codificarlo a Base64 y usarAuthorization: Basic YWJjMTIz
Carga útil
Ejemplo básico (solo campos obligatorios):
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"pageNumberFormat": "# of {1}",
"alignX": "right",
"alignY": "bottom"
}
Ejemplo avanzado (con todos los campos opcionales):
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"pageNumberFormat": "# of {1}",
"alignX": "right",
"alignY": "bottom",
"marginXinMM": 2,
"marginYinMM": 2,
"fontSize": 12,
"isBold": true,
"isItalic": false,
"skipFirstPage": false,
"async": true
}
Ejemplos de código
El PDF4me Agregar número de página a 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#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
Java Muestra
Java Implementación con manejo completo de errores y procesamiento de respuestas:
JavaScript Muestra
Node.js y compatible con navegadores JavaScript implementación:
AWS Lambda Muestra
AWS Lambda implementación con Node.js y API Puerta de enlace:
Características del número de página
Opciones de formato
- Múltiples formatos: Compatibilidad con diversos estilos y patrones de numeración.
- Posicionamiento flexibleControl preciso sobre la ubicación de los números de página.
- Estilo personalizadoControl total sobre la apariencia y el formato de la fuente.
- Control de la primera página: Opción para excluir las portadas de la numeración
Mejora de documentos
- Diseño profesional: Crear una numeración de páginas coherente y profesional en todos los documentos.
- Optimización de impresiónOptimizar la numeración de páginas para diferentes requisitos de impresión.
- Distribución digital: Mantener el formato en diferentes dispositivos de visualización.
- Coherencia de marcaAplicar estándares uniformes de numeración de páginas en todas las organizaciones.
Características avanzadas
- Procesamiento por lotes: Procesar varios documentos con numeración de página consistente.
- Seguro de calidad: Asegurar la integridad y correcta numeración de las páginas PDF compatibilidad
- Preservación del diseño: Mantener la estructura del documento al añadir números de página.
- Márgenes personalizadosControl preciso sobre la posición de los números de página.
Casos de uso y aplicaciones en la industria
- Legal & Professional Services
- Education & Research
- Business & Enterprise
- Government & Compliance
Casos de uso de servicios legales y profesionales
- Documentación legal: Número de páginas en contratos, acuerdos y escritos legales
- Documentos judiciales: Agregar números de página a los documentos judiciales y legales
- Documentación de cumplimiento: Número de páginas en documentos de cumplimiento y reglamentarios
- Documentación del cliente: Organice los documentos de los clientes con numeración de páginas.
Casos de uso en educación e investigación
- Artículos académicosFormatear trabajos de investigación y tesis con la numeración de páginas adecuada.
- Documentos de investigación: Añadir números de página a los artículos y publicaciones de investigación
- Formato de tesisNúmero de páginas en tesis y disertaciones
- Materiales educativos: Organice los documentos educativos con números de página.
Casos de uso para empresas y negocios
- Informes empresariales: Cree informes profesionales con numeración de páginas uniforme.
- Organización de documentos: Añadir números de página a informes, manuales y documentos técnicos.
- Manuales técnicosOrganice la documentación técnica con referencias de página claras.
- Documentación corporativa: Número de páginas en documentos y manuales corporativos
Casos de uso en materia de gobierno y cumplimiento normativo
- Documentos de archivo: Preparar documentos para su almacenamiento a largo plazo con números de página.
- Informes gubernamentales: Agregar números de página a los informes y documentos gubernamentales
- Documentación reglamentaria: Número de páginas en documentos reglamentarios y de cumplimiento
- Registros públicos: Organizar los registros públicos con numeración de páginas