Le API Pubbliche di Documenti e Contratti ti permettono di automatizzare i Workflow relativi ai documenti direttamente all'interno di HITLEAD. Con queste API puoi elencare, inviare e gestire documenti e template in modo fluido, eliminando i processi manuali e semplificando le integrazioni con sistemi esterni.

INDICE

Cosa sono le API Pubbliche di Documenti e Contratti?

Le API Pubbliche di Documenti e Contratti offrono agli sviluppatori accesso programmatico alle funzionalità principali di documenti e contratti in HITLEAD. Ti consentono di recuperare documenti, inviarli ai Contatti, accedere ai template e persino generare e inviare documenti in un unico passaggio. Integrando queste API puoi automatizzare i Workflow, garantire coerenza e scalare la gestione documentale nelle tue applicazioni aziendali.

Vantaggi principali

Usare queste API porta efficienza e automazione nella gestione dei Workflow documentali.

  • Elenco documenti: Recupera un elenco completo dei documenti per un tracciamento preciso.
  • Invio automatizzato: Invia documenti direttamente ai Contatti senza intervento manuale.
  • Accesso ai template: Recupera rapidamente i template disponibili per generare documenti più velocemente.
  • Creazione e invio in un solo passaggio: Crea e invia documenti dai template con una singola chiamata API.
  • Integrazione fluida: Collega i Workflow documentali con altre app e sistemi per ridurre gli attriti.

List Documents

L'endpoint List Documents ti permette di recuperare tutti i documenti all'interno di una specifica location di HITLEAD. È utile per sincronizzare i record documentali nel tuo CRM, Dashboard o app personalizzate. Per maggiori dettagli, consulta List Documents.

  • Ottieni l'elenco completo dei documenti associati al tuo account.
  • Mantieni i record documentali aggiornati in tempo reale.
  • Abilita integrazioni che dipendono dai metadati dei documenti.

Send Document

Con l'endpoint Send Document puoi inviare automaticamente un documento esistente a uno o più Contatti. Questo riduce il tempo speso nell'invio manuale dei documenti e garantisce un processo coerente. Per maggiori dettagli, consulta Send Document.

  • Seleziona un documento esistente da inviare.
  • Scegli uno o più Contatti destinatari.
  • Automatizza la consegna dei documenti per migliorare i tempi di risposta.

List Templates

L'endpoint List Templates fornisce accesso a tutti i template disponibili nella tua location HITLEAD. Permette agli sviluppatori di recuperare i template dinamicamente durante la costruzione di Workflow automatizzati o integrazioni. Per maggiori dettagli, consulta List Templates.

  • Recupera un elenco centralizzato dei template.
  • Identifica il template giusto per ogni caso d'uso.
  • Alimenta le integrazioni con la disponibilità aggiornata dei template.

Send Template

L'endpoint Send Template combina la creazione di un documento da template e l'invio in un'unica chiamata API. Questo riduce il Workflow a una sola azione, rendendo più semplice costruire automazioni su larga scala. Per maggiori dettagli, consulta Send Template.

  • Genera un nuovo documento da un template.
  • Invialo immediatamente ai Contatti designati.
  • Semplifica il processo con meno passaggi.

Come configurare le API Pubbliche di Documenti e Contratti

Configurare correttamente l'accesso alle API garantisce che le tue integrazioni funzionino in modo fluido, sicuro e scalabile. Segui i passaggi seguenti per configurare il tuo account HITLEAD per l'utilizzo delle API.

Step 1: Ottieni le credenziali API

Vai su Agency Settings > Private Integrations nel tuo account HITLEAD e crea un token Private Integration (consigliato rispetto alle chiavi API per una maggiore sicurezza e controllo degli accessi).

IMPORTANTE: Gli scope determinano i permessi che l'app di terze parti ha per accedere ai dati del tuo account o eseguire azioni. Si raccomanda di concedere il minor numero di scope necessario per una migliore sicurezza dell'account.

Schermata 1 — Documenti e Contratti: API Pubbliche

Step 2: Consulta la documentazione API

Visita il portale della documentazione API pubblica. Identifica gli endpoint richiesti dal tuo Workflow (List Documents, Send Document, List Templates, Send Template).

Schermata 2 — Documenti e Contratti: API Pubbliche

Step 3: Testa le chiamate API

Usa uno strumento come Postman per effettuare richieste di esempio. Imposta l'header di autenticazione come Authorization: Bearer <your-token>. Inserisci i parametri richiesti (ID documento, ID template, ID Contatti).

Step 4: Valida le risposte

Esamina l'output JSON di ogni chiamata. Verifica che i documenti o i template vengano restituiti e inviati correttamente.

Step 5: Integra con il tuo Workflow

Incorpora le chiamate API nel tuo CRM, negli script di automazione o nei processi backend. Collega facoltativamente i Workflow di HITLEAD che si attivano in base alle azioni sui documenti (es. "Document Sent" o "Document Signed").

Step 6: Distribuisci in modo sicuro

Conserva i token API in modo sicuro, ruotali periodicamente e monitora l'utilizzo delle API per evitare di raggiungere i limiti di frequenza.

Domande frequenti

D: Quali endpoint sono inclusi nelle API Pubbliche di Documenti e Contratti?

Puoi utilizzare endpoint per elencare documenti, inviare documenti, elencare template e inviare template.

D: Dove trovo la documentazione API ufficiale?

La documentazione completa è disponibile nel portale API pubblico di HITLEAD.

D: Ho bisogno di permessi specifici per accedere a queste API?

Sì, sono necessarie credenziali API valide (preferibilmente token Private Integration) per l'accesso.

D: Come posso testare le API in modo sicuro?

Usa Postman o un client API simile con dati di esempio prima di passare alla produzione.

D: C'è differenza tra usare un documento e usare un template?

Sì. Un documento si riferisce a un file esistente nel tuo account, mentre un template è una struttura predefinita che può essere usata per generare e inviare nuovi documenti.