Signe PDF - Signature numérique API
PDF4me Signe PDF vous permet d'ajouter des images de signature à PDF Des documents dont on peut contrôler la position, la taille et l'apparence. API processus de service PDF fichiers et ajoute des images de signature à l'aide de Base64 Codage pour une transmission sécurisée. API reçoit PDF contenu et données d'image de signature via REST API Cette solution est idéale pour l'authentification de documents, la conformité légale, les flux de travail métier et l'ajout de signatures visuelles aux documents.
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
- Prise en charge de la signature d'image: Ajouter des images de signature personnalisées à PDF documents avec un contrôle total sur le positionnement et la taille
- Positionnement flexibleContrôlez l'alignement horizontal et vertical avec une précision au pixel près.
- Tailles personnalisées: Ajuster les dimensions de la signature à l'aide de mesures en millimètres et en pixels
- Mise en forme avancéeDéfinissez l'opacité, les marges et les options d'arrière-plan pour un rendu professionnel.
- Ciblage de page: Apposer des signatures à des pages spécifiques ou à des documents entiers
- Contrôle d'impressionConfigurez les signatures pour qu'elles n'apparaissent qu'à l'impression ou à l'écran.
- Résultats professionnelsCréez des signatures qui renforcent l'authentification et la sécurité des documents.
- Traitement asynchrone: Prise en charge du traitement asynchrone avec interrogation pour les opérations de longue durée
REST API Point de terminaison
Le PDF4me REST API utilise la norme HTTP méthodes d'interaction avec les ressources. Toutes PDF Les opérations de signature sont effectuées via un point de terminaison unique :
- Méthode: POST
- Point final :
/api/v2/SignPdf
Soutenu PDF Caractéristiques de la signature
Le API offre un soutien complet pour divers PDF capacités de signature :
Support d'image de signature
- Formats courants: Soutien à JPG, PNGet d'autres formats d'image standard
- Base64 Encodage: Transmission sécurisée de la signature via Base64 encodage
- Tailles flexibles: Options de dimensionnement basées sur les millimètres (10-200 mm) et les pixels (20-600 px)
- Préservation de la qualité: Préserve la qualité d'image emblématique dans PDF sortir
Positionnement et mise en page
- Alignement horizontalOptions de positionnement à gauche, au centre et à droite
- Alignement verticalContrôle du positionnement en haut, au milieu et en bas
- Contrôle des margesPositionnement précis grâce à des mesures basées sur le millimètre (0-100 mm) et le pixel (0-300 px)
- Placement flexible: Prise en charge de n'importe quelle position de page avec des mesures exactes
- Ciblage de pageAppliquer à des pages spécifiques ou à des documents entiers (facultatif)
Fonctionnalités avancées
- Contrôle de l'opacitéTransparence réglable (0-100) pour des signatures discrètes ou proéminentes
- Mode arrière-planPossibilité de placer les signatures derrière ou devant le contenu
- Contrôle d'impressionConfigurez les signatures pour qu'elles apparaissent en affichage et impression ou en impression seule.
- Apparence professionnelle: Rendu de signature de haute qualité avec une visibilité claire
REST API Paramètres
Liste complète des paramètres du signe 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* | String | Sortir PDF Nom de fichier avec l'extension .pdf | output.pdf |
| docContent* | Base64 | PDF contenu du fichier encodé en Base64 | JVBERi... |
| fichier image* | Base64 | Contenu du fichier image de signature encodé en Base64 | iVBORw0KGgoAAAANSUhEUgAA... |
| nom_de_l'image* | String | Nom du fichier image de signature avec son extension (par exemple, .jpg, .png) | signature.jpg |
| alignerX* | String | Alignement horizontal : Gauche, Centre, ou Droite | Right |
| aligner* | String | Alignement vertical : Haut, Milieu, ou Bas | Bottom |
Paramètres optionnels
| Paramètre | Taper | Description | Exemple |
|---|---|---|---|
| pages | String | Options de page : « 1 », « 1,3,5 », « 2-5 », « 1,3,7-10 », « 2- ». Si non spécifié, s’applique à toutes les pages. | 1-3 |
| largeur en mm | String | Largeur de la signature en millimètres (10-200) | 50 |
| hauteur en mm | String | Hauteur de la signature en millimètres (10-200) | 25 |
| largeur en pixels | String | Largeur de la signature en pixels (20-600) | 142 |
| hauteur en pixels | String | Hauteur de la signature en pixels (20-600) | 71 |
| margeXInMM | String | Marge horizontale en millimètres (0-100) | 20 |
| margeYInMM | String | Marge verticale en millimètres (0-100) | 20 |
| margeXInPx | String | Marge horizontale en pixels (0-300) | 57 |
| margeYInPx | String | Marge verticale en pixels (0-300) | 57 |
| opacité | String | Opacité (0-100) : 0 = invisible, 100 = totalement opaque | 100 |
| afficherUniquementImprimé | Boolean | Afficher la signature en vue et en impression (vrai) ou en impression seulement (faux) | true |
| estBackground | Boolean | Placer la signature en arrière-plan (vrai) ou au premier plan (faux) | false |
| asynchrone | Boolean | 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 |
Sortir
Le PDF4me Signe 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 signature ajoutée, 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/SignPdf/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,fichier image,nom_de_l'image,alignerX,aligner) - Invalide Base64 encodage dans
docContentoufichier image - Valeurs d'alignement invalides (doivent être « Gauche », « Centre », « Droite » pour alignX ; « Haut », « Milieu », « Bas » pour alignY)
- Valeurs de taille invalides (la largeur et la hauteur doivent être comprises dans les plages spécifiées).
- Valeur d'opacité invalide (doit être comprise 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 de l'ajout de la signature
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==",
"imageFile": "iVBORw0KGgoAAAANSUhEUgAA...",
"imageName": "signature.jpg",
"alignX": "Right",
"alignY": "Bottom"
}
Exemple avancé (avec tous les champs facultatifs) :
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"imageFile": "iVBORw0KGgoAAAANSUhEUgAA...",
"imageName": "signature.jpg",
"pages": "1-3",
"alignX": "Right",
"alignY": "Bottom",
"widthInMM": "50",
"heightInMM": "25",
"widthInPx": "142",
"heightInPx": "71",
"marginXInMM": "20",
"marginYInMM": "20",
"marginXInPx": "57",
"marginYInPx": "57",
"opacity": "100",
"showOnlyInPrint": true,
"isBackground": false,
"async": true
}
Exemples de code
Le PDF4me Signe 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 mise en œuvre pour Google Workspace intégration :
PDF Caractéristiques de la signature
Contrôle de l'image de signature
- Prise en charge des formats: JPG, PNG, GIF et autres formats d'image standard
- Préservation de la qualité: Maintient la qualité et la résolution d'image caractéristiques dans PDF sortir
- Base64 Encodage: Transmission sécurisée de la signature via Base64 encodage
- Tailles flexibles: Options de dimensionnement en millimètres et en pixels
- Apparence professionnelle: Rendu de signature de haute qualité avec une visibilité claire
Positionnement et mise en page
- Contrôle d'alignementOptions d'alignement horizontal et vertical précises
- Paramètres de marge: Positionnement au millimètre et au pixel près
- Placement flexible: Prise en charge de toute position et orientation de page
- Ciblage de pageAppliquer à des pages spécifiques ou à des documents entiers
- Contrôle de la tailleDimensions personnalisables pour un placement optimal
Fonctionnalités avancées
- Contrôle de l'opacitéTransparence ajustable pour des signatures discrètes ou proéminentes
- Mode arrière-planPossibilité de placer les signatures derrière ou devant le contenu
- Contrôle d'impressionConfigurez les signatures pour qu'elles n'apparaissent qu'à l'impression ou à l'écran.
- Résultats professionnelsCréez des signatures qui renforcent l'authentification et la sécurité des documents.
- Positionnement flexibleContrôlez l'alignement horizontal et vertical avec une précision au pixel près.
Cas d'utilisation et applications industrielles
- Legal & Professional Services
- Finance & Banking
- Business & Enterprise
- Government & Compliance
Cas d'utilisation des services juridiques et professionnels
- Documentation juridiqueApposer les signatures sur les contrats, accords et documents officiels.
- Signature du contratSignez les contrats et accords numériquement pour leur validité juridique.
- Documents judiciairesApposer des signatures numériques aux documents judiciaires et juridiques.
- Exigences de conformitéRespecter les exigences réglementaires en matière de signature et d'authentification des documents
Cas d'utilisation dans le secteur financier et bancaire
- Signature de facturesSigner les factures et les bons de commande numériquement
- Documents financiersApposer les signatures aux rapports et états financiers
- Documents de prêt: Signer les contrats de prêt et les documents financiers numériquement
- Conformité réglementaire: Respecter les exigences réglementaires en matière de signature de documents financiers
Cas d'utilisation en entreprise
- Flux de travail métierSignez numériquement les factures, les bons de commande et les documents commerciaux.
- Authentification des documentsAjouter des signatures numériques aux documents PDF à des fins d'authentification et de vérification
- Génération de rapportsAjouter des signatures aux rapports générés et aux documents officiels
- Documentation d'entreprise: Signer les documents de l'entreprise et les communications officielles
Cas d'utilisation gouvernementaux et de conformité
- Exigences de conformitéRespecter les exigences réglementaires en matière de signature et d'authentification des documents
- Documents gouvernementauxApposer des signatures numériques aux documents et formulaires gouvernementaux
- Documentation réglementaireSigner numériquement les documents réglementaires et de conformité
- Archives publiquesApposer des signatures sur les documents publics et officiels.