Vai al contenuto

API per sviluppatori · Aggiornato

Porta la firma dentro il tuo prodotto.

Crea documenti da un PDF, un file Word o un modello, inviali per la firma, seguine lo stato e ricevi webhook quando vengono firmati, tutto dal tuo codice.

API REST

Webhook

Chiavi API

L'API di eSignSimple è già attiva?

Il tuo software ora può creare documenti, inviarli per la firma, seguirne lo stato e scaricare le copie firmate senza che nessuno debba accedere a una dashboard. L'API REST si trova su https://esignsimple.com/api/v1 e il riferimento completo, con esempi di richieste e risposte, è sulla nostra pagina per sviluppatori.

I firmatari raggiunti tramite l'API hanno esattamente la stessa esperienza di firma senza account e le stesse prove dei documenti inviati dalla dashboard: un audit trail, un certificato di firma e un hash SHA-256 che chiunque può verificare sulla nostra pagina pubblica di verifica.

Come funziona l'API?

Crea un documento con POST /documents. Invii una richiesta multipart con il PDF e una parte JSON che elenca firmatari e campi, dove le posizioni dei campi sono espresse come frazioni della pagina: non devi preoccuparti di punti PDF o formati di pagina. Il documento viene inviato subito, oppure resta in bozza se passi send:false.

Hai già un modello nella dashboard? POST /templates/{id}/send compila i firmatari e lo invia. GET /documents elenca i tuoi documenti con un filtro per stato e paginazione a cursore tramite before. GET /documents/{id} restituisce lo stato, i firmatari e l'audit trail completo, e GET /documents/{id}/download restituisce il PDF firmato una volta completato il documento, oppure l'originale con ?file=original.

Puoi anche annullare un documento in corso con POST /documents/{id}/void, eliminarne uno con DELETE /documents/{id} e controllare il tuo piano e l'utilizzo attuale con GET /me.

Come funzionano autenticazione e chiavi API?

Ogni richiesta usa una chiave API Bearer. Crei e revochi le chiavi in Impostazioni → Sviluppatori. Una chiave viene mostrata una sola volta al momento della creazione e noi ne conserviamo solo un hash, quindi copiala subito nel tuo gestore di segreti. Se una chiave viene esposta, revocala e creane una nuova; non serve cambiare nient'altro.

La stessa API accetta anche i token ID di Firebase, che è ciò che userà la nostra prossima app mobile. È una scelta voluta: costruiamo le nostre app sulla stessa API pubblica che usi tu, così viene messa alla prova ogni giorno.

Quali webhook puoi ricevere?

Invece di interrogare continuamente l'API, registra un endpoint HTTPS per il tuo account e lo avviseremo quando succede qualcosa. Gli eventi sono document.completed, document.declined, document.voided e signer.signed.

Ogni consegna è firmata con HMAC-SHA256 e la firma viene inviata nell'header esign-signature, così puoi confermare che la richiesta arriva davvero da noi prima di agire. Se il tuo endpoint non risponde correttamente, riproviamo una volta. Il nostro consiglio: tratta i webhook come un innesco e chiama GET /documents/{id} per lo stato ufficiale.

Cosa si costruisce con l'API?

Un CRM o uno strumento di preventivazione che invia un contratto nel momento in cui una trattativa viene segnata come vinta. Un sistema HR che invia un pacchetto di onboarding da un modello quando un'assunzione viene confermata. Un gestionale immobiliare che invia un contratto di locazione e archivia il PDF firmato sull'immobile quando arriva document.completed. Uno script interno che evita a qualcuno di copiare a mano righe da un foglio di calcolo nei contratti.

Se invii una manciata di documenti a settimana, probabilmente l'API non ti serve affatto. Modelli, invio massivo e moduli web nella dashboard ti bastano con molto meno sforzo.

Quanto costa l'API?

Non esiste un piano API separato. Valgono gli stessi limiti di piano dell'app web: il piano Free include 5 documenti al mese e Personal è illimitato (vedi i prezzi). I documenti creati tramite l'API contano esattamente come quelli inviati dalla dashboard.

I grandi fornitori come DocuSign, Dropbox Sign e Adobe di solito prezzano le loro API separatamente dai piani utente, spesso in base a volumi annuali di buste, e i piani API d'ingresso possono costare molto più dei loro abbonamenti standard. Controlla i loro siti per i prezzi aggiornati.

Cosa non è ancora incluso?

Siamo onesti sulle lacune. Non c'è ancora un iframe per la firma incorporata, quindi i firmatari firmano sempre tramite il link che inviamo loro via e-mail. Non ci sono SDK ufficiali; l'API è semplice HTTP e JSON, quindi funziona con qualsiasi linguaggio dotato di un client HTTP. Non c'è un ambiente sandbox separato, quindi fai i test con un account gratuito e i tuoi indirizzi e-mail. Tutto questo è nella nostra roadmap.

Perché siamo partiti con un'API piccola?

Abbiamo scelto di partire in piccolo. Un'API ridotta che gestisce bene il flusso più comune, con limiti prevedibili e senza chiamate commerciali, è più utile di una superficie enorme che richiede settimane di integrazione. Se ti manca qualcosa, raccontaci cosa stai costruendo: sono le integrazioni reali a decidere cosa aggiungeremo dopo.

Quali endpoint API esistono oggi?

EndpointCosa faUso tipico
POST /documentsCarica un PDF con firmatari e campi, lo invia o lo tiene in bozzaInviare un contratto generato dalla tua app
POST /templates/{id}/sendInvia un modello della dashboard a firmatari indicatiPacchetto di onboarding quando un'assunzione è confermata
GET /documents, GET /documents/{id}Elenca i documenti o legge stato, firmatari e audit trailSincronizzare lo stato in un CRM
GET /documents/{id}/downloadScarica il PDF firmato (o l'originale)Archiviare la copia firmata in una scheda
POST /documents/{id}/void e DELETE /documents/{id}Annulla o elimina un documentoRitirare un'offerta o ripulire le bozze
GET /mePiano e utilizzo del meseAvvisare prima di raggiungere il limite del Free

Domande frequenti

eSignSimple ha un'API?

Sì. L'API REST è attiva su https://esignsimple.com/api/v1 con chiavi API Bearer e webhook. Il riferimento è sulla nostra pagina per sviluppatori.

Quanto costa l'API?

Non ci sono prezzi separati per l'API. Si applica il tuo piano normale: il Free include 5 documenti al mese, Personal è illimitato.

Come ottengo una chiave API?

Creala in Impostazioni → Sviluppatori. Viene mostrata una sola volta e conservata come hash, quindi salvala subito. Puoi revocare le chiavi in qualsiasi momento.

Quali eventi webhook sono disponibili?

document.completed, document.declined, document.voided e signer.signed, firmati con HMAC-SHA256 nell'header esign-signature, con un nuovo tentativo.

Supportate firma incorporata, SDK o sandbox?

Non ancora. Tutte e tre sono nella nostra roadmap. Oggi i firmatari firmano tramite un link inviato via e-mail e tu chiami l'API in semplice HTTP.

Letture correlate

Fai firmare il tuo prossimo documento oggi stesso.

5 documenti gratuiti al mese per iniziare. Nessuna carta di credito richiesta.