Ajouter le numéro de page à PDF - Pagination API
PDF4me Ajouter le numéro de page à PDF vous permet d'ajouter des numéros de page personnalisables à PDF Des documents avec contrôle sur la position, le format et le style. API processus de service PDF et ajoute des numéros de page aux fichiers en utilisant des espaces réservés de format où # représente le numéro de page actuel et {1} représente le nombre total de pages. API reçoit PDF contenu via REST API appels, utilisant Base64 Encodage pour une transmission sécurisée. Cette solution est idéale pour l'organisation de documents, les documents juridiques, les articles universitaires et les applications d'entreprise. PDF flux de travail.
Authentification de votre API Demande
Pour accéder au PDF4me REST APIChaque requête doit inclure des informations d'authentification valides. L'authentification garantit la sécurité des communications et confirme votre identité en tant qu'utilisateur autorisé. REST API.
Caractéristiques principales
- Mise en forme flexible: Choisissez parmi plusieurs formats de numérotation de page en utilisant
#pour la page actuelle et{1}pour le nombre total de pages (par exemple, « nombre de 1", "Page #") - Positionnement précisContrôlez l'alignement horizontal et vertical avec une précision au pixel près.
- Style personnaliséAjuster la taille de la police, le gras, l'italique et d'autres options de mise en forme du texte
- Contrôle des margesDéfinissez des marges précises en millimètres pour un placement optimal
- Passer la première page: Option permettant d'exclure les numéros de page de la première page
- Résultats professionnelsCréer une numérotation de pages cohérente et professionnelle pour tous les documents.
REST API Point de terminaison
Le PDF4me REST API utilise la norme HTTP méthodes d'interaction avec les ressources. Toutes les opérations d'ajout de numéros de page sont effectuées via un point de terminaison unique :
- Méthode: POSTE
- Point final :
/api/v2/AddPageNumber
REST API Paramètres
Liste complète des paramètres pour l'ajout d'un numéro de page à PDF REST APILes paramètres sont organisés par catégorie pour une meilleure compréhension et une mise en œuvre plus aisée.
Important: Les paramètres marqués d'un astérisque (*) sont obligatoires et doivent être fournis pour le API pour fonctionner correctement.
Paramètres requis
| Paramètre | Taper | Description | Exemple |
|---|---|---|---|
| Nom du document* | Chaîne | Sortir PDF Nom de fichier avec l'extension .pdf | output.pdf |
| docContent* | Base64 | PDF contenu du fichier encodé en Base64 | JVBERi... |
| formatNuméroDePage* | Chaîne | Format de numérotation des pages. Utilisez # pour le numéro de page actuel, {1} pour le nombre total de pages. Exemples : « nombre de 1", "Page #", "# / 1" | # of {1} |
| alignerX* | Chaîne | Alignement horizontal : gauche, centre, ou droite | right |
| aligner* | Chaîne | Alignement vertical : haut, milieu, ou bas | bottom |
Paramètres optionnels
| Paramètre | Taper | Description | Exemple |
|---|---|---|---|
| margeXinMM | Entier | Marge horizontale par rapport au bord en millimètres (0-100) | 2 |
| margeEnMM | Entier | Marge verticale par rapport au bord en millimètres (0-100) | 2 |
| taille de police | Entier | Taille de la police pour les numéros de page (8-72) | 12 |
| boule de glace | booléen | Mettre les numéros de page en gras (vrai) ou en format normal (faux) | true |
| isItalique | booléen | Mettre les numéros de page en italique (vrai) ou en normal (faux) | false |
| skipFirstPage | booléen | Omettre la numérotation sur la première page (vrai) ou l'inclure (faux) | false |
| asynchrone | booléen | Activer le traitement asynchrone. Lorsque true, le API renvoie un statut 202 et fournit un système d'interrogation URL dans le Location en-tête | true |
Espaces réservés pour le format des numéros de page
Le pageNumberFormat Ce paramètre utilise les espaces réservés suivants :
#- Remplacé par le numéro de page actuel (1, 2, 3, etc.){1}- Remplacé par le nombre total de pages
Exemples de format :
"# of {1}"→ Affiche « 1 sur 10 », « 2 sur 10 », « 3 sur 10 », etc."Page #"→ Affiche « Page 1 », « Page 2 », « Page 3 », etc."# / {1}"→ Affiche « 1 / 10 », « 2 / 10 », « 3 / 10 », etc."- # -"→ Affiche « - 1 - », « - 2 - », « - 3 - », etc."[#/{1}]"→ Affiche « [1/10] », « [2/10] », « [3/10] », etc."(#)"→ Affiche « (1) », « (2) », « (3) », etc."#"→ Affiche uniquement le numéro de page : « 1 », « 2 », « 3 », etc.
Sortir
Le PDF4me Ajouter le numéro de page à PDF REST API renvoie des réponses différentes selon le mode de traitement. API renvoie le PDF comme un Base64chaîne encodée dans JSON format, et non sous forme de données binaires.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Traitement synchrone (par défaut)
Quand async n'est pas défini ou est défini sur false, le API traite la demande immédiatement :
Code d'état : 200 OK
Content-Type: application/json
Corps de la réponse :
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg=="
}
Champs de réponse :
- Nom du document (chaîne de caractères) : La sortie PDF nom de fichier
- docContent (chaîne de caractères) : Le PDF fichier avec numéros de page ajoutés, encodé comme Base64 chaîne
Mode d'emploi :
- Extraire le
docContentchamp du JSON réponse - Décodez le Base64 chaîne permettant d'obtenir le binaire PDF données
- Enregistrer ou traiter le PDF classer selon les besoins
Exemple (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const pdfBytes = atob(data.docContent); // Decode Base64
// Save or process pdfBytes
Traitement asynchrone
Quand async: true est réglé, le API traite la requête de manière asynchrone :
Code d'état : 202 Accepted
En-têtes de réponse :
Location: https://api.pdf4me.com/api/v2/AddPageNumber/poll/12345-abcde-67890
Processus de sondage :
- Extraire le
LocationEn-tête de la réponse 202 - Sondage URL en utilisant GET demandes
- Continuez à sonder jusqu'à ce que vous receviez un 200 OK statut
- La réponse finale contient la même chose JSON format avec
docNameetdocContent(Base64)
Exemple de sondage :
// 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
}
Réponses d'erreur
Le API retours standard HTTP codes d'erreur avec détails de l'erreur :
- Paramètres de requête invalides
- Champs obligatoires manquants (
docContent,Nom du document,formatNuméroDePage,alignerX,aligner) - Invalide Base64 encodage dans
docContent - Valeurs d'alignement invalides (doivent être « left », « center », « right » pour alignX ; « top », « middle », « bottom » pour alignY)
- Taille de police invalide (doit être comprise entre 8 et 72)
- Valeurs de marge invalides (doivent être des entiers compris entre 0 et 100)
- Invalide ou manquant API clé
- API clé non correctement Base64 encodé dans Authorization en-tête
- Manquant
Autorisation : de baseen-tête
- Erreur de traitement côté serveur
- PDF échec du traitement
- échec d'addition du numéro de page
Format de réponse en cas d'erreur :
{
"error": "Error message describing what went wrong"
}
Détails du format de réponse
Important: Le API toujours retourne JSON, jamais binaire PDF données directement.
Structure de la réponse :
{
"docName": "string", // Output PDF filename
"docContent": "string" // Base64-encoded PDF content
}
Content-Type En-tête :
- Succès:
application/json - Le PDF est intégré en tant que Base64 chaîne à l'intérieur de la JSON réponse
Pourquoi Base64?
- JSON-codage sûr pour les données binaires
- Facile à transmettre sur HTTP
- Compatible avec tous les langages de programmation
- Peut être directement intégré dans JSON sans échapper aux problèmes
Décodage Base64 à 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);
Exemple de requête
En-tête
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Note:
- Obtenez votre API clé de la PDF4me Tableau de bord
- Le API La clé doit être Base64 encodé et préfixé par « Basic » dans le Authorization en-tête
- Exemple : Si votre API La clé est
abc123, encodez-le en Base64 et utiliserAuthorization: Basic YWJjMTIz
Charge utile
Exemple simple (champs obligatoires uniquement) :
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"pageNumberFormat": "# of {1}",
"alignX": "right",
"alignY": "bottom"
}
Exemple avancé (avec tous les champs facultatifs) :
{
"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
}
Exemples de code
Le PDF4me Ajouter le numéro de page à PDF REST API propose des exemples de code dans plusieurs langages de programmation. Choisissez le langage qui convient le mieux à votre environnement de développement :
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
Java Échantillon
Java implémentation avec gestion complète des erreurs et traitement des réponses :
JavaScript Échantillon
Node.js et compatible avec les navigateurs JavaScript mise en œuvre:
Python Échantillon
Python implémentation avec la bibliothèque requests et JSON manutention:
Google Script Échantillon
Google Apps Script implémentation avec UrlFetchApp :
AWS Lambda Échantillon
AWS Lambda mise en œuvre avec Node.js et API Passerelle :
Fonctionnalités de numérotation des pages
Options de mise en forme
- Formats multiples: Prise en charge de différents styles et modèles de numérotation
- Positionnement flexibleContrôle précis du placement des numéros de page
- Style personnaliséContrôle total de l'apparence et de la mise en forme des polices
- Contrôle de la première page: Option permettant d'exclure les pages de couverture de la numérotation
Amélioration des documents
- Mise en page professionnelleCréer une numérotation de pages cohérente et professionnelle pour tous les documents.
- Optimisation d'impressionOptimiser la numérotation des pages en fonction des différentes exigences d'impression
- Distribution numériqueConserver la mise en forme sur différents appareils de visualisation
- Cohérence de la marqueAppliquer des normes uniformes de numérotation des pages dans toutes les organisations
Fonctionnalités avancées
- Traitement par lots: Traiter plusieurs documents avec une numérotation de pages cohérente
- Assurance qualité: Assurez-vous de l'intégrité et de la conformité de la numérotation des pages. PDF compatibilité
- Préservation de l'agencement: Conserver la structure du document tout en ajoutant les numéros de page
- Marges personnaliséesContrôle précis du positionnement des numéros de page
Cas d'utilisation et applications industrielles
- Legal & Professional Services
- Education & Research
- Business & Enterprise
- Government & Compliance
Cas d'utilisation des services juridiques et professionnels
- Documentation juridiqueNuméroter les pages des contrats, accords et documents juridiques
- Documents judiciaires: Ajouter des numéros de page aux documents judiciaires et aux pièces juridiques
- Documentation de conformitéNumérotez les pages des documents de conformité et réglementaires.
- Documentation client: Organiser les documents clients en numérotant les pages
Cas d'utilisation dans le domaine de l'éducation et de la recherche
- Articles académiques: Mettre en forme les articles de recherche et les thèses en respectant la numérotation des pages.
- Documents de rechercheAjouter des numéros de page aux articles de recherche et aux publications
- Mise en forme de la thèse: Numéroter les pages des thèses et des mémoires
- Matériel pédagogique: Organiser les documents pédagogiques en indiquant les numéros de page
Cas d'utilisation en entreprise
- Rapports d'entreprise: Créer des rapports professionnels avec une pagination cohérente
- Organisation des documentsAjoutez des numéros de page aux rapports, manuels et documents techniques.
- Manuels techniques: Organiser la documentation technique avec des références de page claires
- Documentation d'entrepriseNuméroter les pages des documents et manuels d'entreprise
Cas d'utilisation gouvernementaux et de conformité
- Documents d'archives: Préparer les documents pour l'archivage à long terme en indiquant les numéros de page
- Rapports gouvernementauxAjouter des numéros de page aux rapports et documents gouvernementaux
- Documentation réglementaireNumérotez les pages des documents réglementaires et de conformité.
- Archives publiques: Organiser les documents publics avec une pagination