Cartello PDF - Firma digitale API
PDF4me Cartello PDF ti consente di aggiungere immagini della firma a PDF documenti con controllo su posizione, dimensione e aspetto. Questo API processi di servizio PDF file e aggiunge immagini di firma utilizzando Base64 codifica per la trasmissione sicura. API riceve PDF dati relativi al contenuto e all'immagine della firma tramite REST API chiamate. Questa soluzione è ideale per l'autenticazione dei documenti, la conformità legale, i flussi di lavoro aziendali e l'aggiunta di firme visive ai documenti.
Autenticazione del tuo API Richiesta
Per accedere al PDF4me REST API, ogni richiesta deve includere credenziali di autenticazione adeguate. L'autenticazione garantisce una comunicazione sicura e convalida la tua identità come utente autorizzato del REST API.
Caratteristiche principali
- Supporto per la firma immagine: Aggiungi immagini di firma personalizzate a PDF documenti con pieno controllo su posizionamento e dimensionamento
- Posizionamento flessibile: Controllo dell'allineamento orizzontale e verticale con precisione al pixel
- Dimensioni personalizzateRegola le dimensioni della firma utilizzando sia le misurazioni in millimetri che in pixel.
- Formattazione avanzataImposta opacità, margini e opzioni di sfondo per un aspetto professionale.
- Targeting della pagina: Applicare le firme a pagine specifiche o a interi documenti
- Controllo di stampaConfigura le firme in modo che vengano visualizzate solo in stampa o solo a schermo
- Risultati professionali: Creare firme che migliorino l'autenticazione e la sicurezza dei documenti
- Elaborazione asincronaSupporto per l'elaborazione asincrona con polling per operazioni di lunga durata
REST API Punto finale
IL PDF4me REST API utilizza standard HTTP metodi per interagire con le risorse. Tutti PDF Le operazioni di firma vengono eseguite tramite un unico endpoint:
- Metodo: POST
- Punto finale:
/api/v2/SignPdf
Supportato PDF Funzionalità di firma
IL API fornisce un supporto completo per vari PDF funzionalità di firma:
Supporto per l'immagine della firma
- Formati comuni: Supporto per JPG, PNGe altri formati di immagine standard
- Base64 Codifica: Trasmissione sicura della firma tramite Base64 codifica
- Taglie flessibili: Opzioni di dimensionamento basate sia su millimetri (10-200 mm) che su pixel (20-600 pixel).
- Conservazione della qualità: Mantiene la qualità dell'immagine della firma in PDF produzione
Posizionamento e disposizione
- Allineamento orizzontaleOpzioni di posizionamento: Sinistra, Centro e Destra
- Allineamento verticaleControllo del posizionamento in alto, al centro e in basso
- Controllo dei marginiPosizionamento preciso con misurazioni sia in millimetri (0-100 mm) che in pixel (0-300 px).
- Inserimento flessibileSupporto per qualsiasi posizione della pagina con misurazioni precise
- Targeting della pagina: Applica a pagine specifiche o a interi documenti (facoltativo)
Funzionalità avanzate
- Controllo dell'opacitàTrasparenza regolabile (0-100) per firme discrete o evidenti
- Modalità in backgroundOpzione per posizionare le firme dietro o davanti al contenuto
- Controllo di stampaConfigura le firme in modo che vengano visualizzate e stampate oppure solo stampate.
- Aspetto professionale: Rendering della firma di alta qualità con chiara visibilità
REST API Parametri
Elenco completo dei parametri per il Segno PDF REST APII parametri sono organizzati per categoria per una migliore comprensione e implementazione.
Importante: I parametri contrassegnati da un asterisco (*) sono obbligatori e devono essere forniti per il API per funzionare correttamente.
Parametri richiesti
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| docName* | String | Produzione PDF nome del file con estensione .pdf | output.pdf |
| docContent* | Base64 | PDF contenuto del file codificato in Base64 | JVBERi... |
| file immagine* | Base64 | Contenuto del file immagine della firma codificato in Base64 | iVBORw0KGgoAAAANSUhEUgAA... |
| nomeimmagine* | String | Nome del file immagine della firma con estensione (ad esempio, .jpg, .png) | signature.jpg |
| allineaX* | String | Allineamento orizzontale: Sinistra, Centro, O Giusto | Right |
| allineamentoY* | String | Allineamento verticale: Superiore, Mezzo, O Metter il fondo a | Bottom |
Parametri opzionali
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| pagine | String | Opzioni pagina: "1", "1,3,5", "2-5", "1,3,7-10", "2-". Se non specificato, si applica a tutte le pagine. | 1-3 |
| larghezzaInMM | String | Larghezza della firma in millimetri (10-200) | 50 |
| altezza in mm | String | Altezza della firma in millimetri (10-200) | 25 |
| larghezzaInPx | String | Larghezza della firma in pixel (20-600) | 142 |
| altezzaInPx | String | Altezza della firma in pixel (20-600) | 71 |
| marginXInMM | String | Margine orizzontale in millimetri (0-100) | 20 |
| marginYInMM | String | Margine verticale in millimetri (0-100) | 20 |
| marginXInPx | String | Margine orizzontale in pixel (0-300) | 57 |
| marginYInPx | String | Margine verticale in pixel (0-300) | 57 |
| opacità | String | Opacità (0-100): 0=invisibile, 100=completamente opaco | 100 |
| mostra solo in formato cartaceo | Boolean | Mostra la firma in vista e stampala (vero) oppure stampala soltanto (falso) | true |
| è lo sfondo | Boolean | Posiziona la firma sullo sfondo (vero) o in primo piano (falso) | false |
| asincrono | Boolean | Abilita l'elaborazione asincrona. Quando true, IL API restituisce uno stato 202 e fornisce un polling URL nel Location intestazione | true |
Produzione
IL PDF4me Cartello PDF REST API restituisce risposte diverse a seconda della modalità di elaborazione. API restituisce il PDF come Base64-stringa codificata in JSON formato, non come dati binari.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Elaborazione sincrona (impostazione predefinita)
Quando async non è impostato o impostato su false, IL API elabora la richiesta immediatamente:
Codice di stato: 200 OK
Content-Type: application/json
Corpo della risposta:
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg=="
}
Campi di risposta:
- docName (stringa): L'output PDF nome del file
- docContent (stringa): La PDF file con firma aggiunta, codificato come Base64 corda
Come si usa:
- Estrarre il
docContentcampo dal JSON risposta - decodificare il Base64 stringa per ottenere il binario PDF dati
- Salva o elabora il PDF file secondo necessità
Esempio (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const pdfBytes = atob(data.docContent); // Decode Base64
// Save or process pdfBytes
Elaborazione asincrona
Quando async: true è impostato, il API elabora la richiesta in modo asincrono:
Codice di stato: 202 Accepted
Intestazioni di risposta:
Location: https://api.pdf4me.com/api/v2/SignPdf/poll/12345-abcde-67890
Procedura di votazione:
- Estrarre il
Locationintestazione dalla risposta 202 - Sondare il URL utilizzando GET richieste
- Continua a fare sondaggi finché non ricevi un 200 OK stati
- La risposta finale contiene lo stesso JSON formato con
docNameEdocContentBase64)
Esempio di sondaggio:
// 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
}
Risposte di errore
IL API resi standard HTTP Codici di errore con dettagli dell'errore:
- Parametri di richiesta non validi
- Campi obbligatori mancanti (
docContent,docName,file immagine,nomeimmagine,allineaX,allineamentoY) - Non valido Base64 codifica in
docContentOfile immagine - Valori di allineamento non validi (devono essere "Sinistra", "Centro", "Destra" per allineamentoX; "Superiore", "Centro", "Inferiore" per allineamentoY)
- Valori di dimensione non validi (larghezza/altezza devono rientrare negli intervalli specificati)
- Valore di opacità non valido (deve essere compreso tra 0 e 100)
- Non valido o mancante API chiave
- API chiave non corretta Base64 codificato in Authorization intestazione
- Mancante
Autorizzazione: Baseintestazione
- Errore di elaborazione lato server
- PDF errore di elaborazione
- Errore nell'aggiunta della firma
Formato della risposta di errore:
{
"error": "Error message describing what went wrong"
}
Dettagli sul formato di risposta
Importante: IL API ritorna sempre JSONmai binario PDF dati direttamente.
Struttura della risposta:
{
"docName": "string", // Output PDF filename
"docContent": "string" // Base64-encoded PDF content
}
Content-Type Intestazione:
- Successo:
application/json - IL PDF è incorporato come un Base64 stringa all'interno della JSON risposta
Perché Base64?
- JSON- codifica sicura per dati binari
- Facile da trasmettere HTTP
- Compatibile con tutti i linguaggi di programmazione
- Può essere incorporato direttamente in JSON senza sfuggire ai problemi
Codifica 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);
Esempio di richiesta
Intestazione
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Nota:
- Ottieni il tuo API chiave dalla PDF4me Pannello di controllo
- IL API la chiave deve essere Base64 codificato e prefissato con "Basic" nel Authorization intestazione
- Esempio: se il tuo API la chiave è
abc123, codificalo in Base64 e utilizzareAuthorization: Basic YWJjMTIz
Carico utile
Esempio di base (solo campi obbligatori):
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"imageFile": "iVBORw0KGgoAAAANSUhEUgAA...",
"imageName": "signature.jpg",
"alignX": "Right",
"alignY": "Bottom"
}
Esempio avanzato (con tutti i campi opzionali):
{
"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
}
Esempi di codice
IL PDF4me Cartello PDF REST API Fornisce esempi di codice in diversi linguaggi di programmazione. Scegli il linguaggio più adatto al tuo ambiente di sviluppo:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
Java Campione
Java implementazione con gestione completa degli errori ed elaborazione delle risposte:
JavaScript Campione
Node.js e compatibile con i browser JavaScript implementazione:
Google Script Campione
Google Apps Script implementazione per Google Workspace integrazione:
PDF Funzionalità di firma
Controllo dell'immagine della firma
- Supporto formato: JPG, PNG, GIF e altri formati di immagine standard
- Conservazione della qualità: Mantiene la qualità e la risoluzione dell'immagine della firma in PDF produzione
- Base64 Codifica: Trasmissione sicura della firma tramite Base64 codifica
- Taglie flessibili: Opzioni di dimensionamento sia in millimetri che in pixel
- Aspetto professionale: Rendering della firma di alta qualità con chiara visibilità
Posizionamento e disposizione
- Controllo dell'allineamentoOpzioni di allineamento orizzontale e verticale precise
- Impostazioni dei margini: Posizionamento sia in millimetri che in pixel
- Inserimento flessibileSupporto per qualsiasi posizione e orientamento della pagina
- Targeting della pagina: Applicabile a pagine specifiche o a interi documenti
- Controllo delle dimensioniDimensioni personalizzabili per un posizionamento ottimale
Funzionalità avanzate
- Controllo dell'opacitàTrasparenza regolabile per firme discrete o evidenti
- Modalità in backgroundOpzione per posizionare le firme dietro o davanti al contenuto
- Controllo di stampaConfigura le firme in modo che vengano visualizzate solo in stampa o solo a schermo
- Risultati professionali: Creare firme che migliorino l'autenticazione e la sicurezza dei documenti
- Posizionamento flessibile: Controllo dell'allineamento orizzontale e verticale con precisione al pixel
Casi d'uso e applicazioni industriali
- Legal & Professional Services
- Finance & Banking
- Business & Enterprise
- Government & Compliance
Casi d'uso per servizi legali e professionali
- Documentazione legaleApporre firme su contratti legali, accordi e documenti ufficiali.
- Firma del contrattoFirma contratti e accordi in formato digitale per la loro validità legale.
- Documenti del tribunale: Applicare firme digitali ad atti giudiziari e documenti legali
- Requisiti di conformità: Soddisfare i requisiti normativi per la firma e l'autenticazione dei documenti
Casi d'uso in ambito finanziario e bancario
- Firma della fatturaFirma digitalmente fatture e ordini di acquisto
- Documenti finanziariApporre le firme sui bilanci e sui rendiconti finanziari
- Documenti di prestitoFirma digitalmente i contratti di prestito e i documenti finanziari.
- Conformità normativa: Soddisfare i requisiti normativi per la firma dei documenti finanziari
Casi d'uso aziendali e per le imprese
- Flussi di lavoro aziendaliFirma digitalmente fatture, ordini di acquisto e documenti commerciali.
- Autenticazione dei documentiAggiungi firme digitali ai documenti PDF per l'autenticazione e la verifica
- Generazione di report: Aggiungi firme ai report e ai documenti ufficiali generati
- Documentazione aziendale: Firma documenti aziendali e comunicazioni ufficiali
Casi d'uso per la pubblica amministrazione e la conformità normativa.
- Requisiti di conformità: Soddisfare i requisiti normativi per la firma e l'autenticazione dei documenti
- Documenti governativi: Apporre firme digitali su documenti e moduli governativi
- Documentazione normativa: Firma digitalmente i documenti normativi e di conformità
- Registri pubbliciApporre firme su registri pubblici e documenti ufficiali