Automatizza i Workflow dei documenti in HITLEAD con le API Pubbliche di Documenti e Contratti. Queste API permettono agli sviluppatori di elencare documenti, inviare documenti esistenti ai Contatti, recuperare template e generare documenti da template senza intervento manuale. Questo semplifica la sincronizzazione dei record, l'attivazione della consegna di documenti da sistemi esterni e la gestione dei processi legati ai contratti all'interno di HITLEAD. La funzionalità fa parte dell'esperienza più ampia di Documenti e Contratti in HITLEAD ed è progettata per un utilizzo programmatico.

INDICE DEI CONTENUTI

Cosa sono le API Pubbliche di Documenti e Contratti?

Le API Pubbliche di Documenti e Contratti offrono agli sviluppatori un modo per lavorare con i documenti in HITLEAD tramite richieste API invece di azioni manuali nell'app. Sono utili quando hai bisogno di connettere HITLEAD con sistemi esterni, automatizzare l'invio dai tuoi Workflow o creare dinamicamente documenti da template salvati. Queste API sono limitate alla location HITLEAD pertinente e sono indicate quando il tuo processo richiede un'automazione guidata dagli sviluppatori, anziché affidarsi esclusivamente a un Workflow no-code.

Le API Pubbliche di Documenti e Contratti supportano attualmente le principali azioni del Workflow documentale, tra cui:

  • Elencare i documenti in una location
  • Inviare un documento esistente a uno o più Contatti
  • Elencare i template in una location
  • Creare e inviare un documento da un template in un'unica richiesta

Vantaggi principali delle API Pubbliche di Documenti e Contratti

Le API Pubbliche di Documenti e Contratti aiutano i team a ridurre il lavoro manuale e a collegare le operazioni documentali al resto del loro stack tecnologico. Sono particolarmente utili per le aziende che vogliono un controllo più preciso su quando i documenti vengono generati, inviati e seguiti.

  • Automatizza la consegna dei documenti: invia documenti da strumenti esterni, app personalizzate o sistemi interni senza aprire manualmente HITLEAD.
  • Usa i template salvati in modo efficiente: genera nuovi documenti da template esistenti con una sola chiamata API per velocizzare i processi ripetibili.
  • Mantieni i dati dei documenti sincronizzati: recupera elenchi di documenti e template per Reportistica, sincronizzazione di sistema o visibilità operativa.
  • Supporta Workflow scalabili: collega gli invii basati su API con Trigger di Workflow successivi per promemoria, follow-up e automazione basata sullo stato.
  • Riduci gli errori manuali: standardizza la selezione e l'invio dei template tra team, sistemi o processi rivolti ai clienti.

List Documents

L'elenco dei documenti ti permette di recuperare i record dei documenti disponibili in una specifica location HITLEAD. È utile per le integrazioni che devono sincronizzare gli inventari dei documenti, visualizzare gli elementi disponibili in un altro sistema o verificare quali asset esistono già prima di avviare ulteriori azioni.

Puoi usare l'endpoint List Documents per:

  • Recuperare i documenti disponibili in una location
  • Supportare la sincronizzazione tra HITLEAD e un sistema esterno
  • Creare strumenti interni che fanno riferimento ai record di documenti esistenti
  • Ridurre la creazione di duplicati verificando cosa esiste già

Schermata 1 — Documenti e Contratti: API Pubbliche

Send Document

L'invio di un documento esistente tramite API è utile quando un documento è già stato preparato in HITLEAD e deve solo essere consegnato al Contatto giusto al momento giusto. Questo supporta logiche di business personalizzate, Trigger da applicazioni esterne e automazione guidata dagli sviluppatori che va oltre le azioni standard dei Workflow.

Puoi usare l'endpoint Send Document per:

  • Inviare un documento già pronto a un Contatto
  • Avviare la consegna di un documento da un form esterno, un portale o un'app
  • Standardizzare gli invii di documenti in Workflow personalizzati
  • Ridurre i passaggi manuali per i team di vendita o di onboarding

Tieni presente che:

  • Il documento deve esistere già in HITLEAD prima di poter essere inviato
  • Il comportamento del destinatario deve seguire le capacità definite nella documentazione ufficiale delle API
  • Gli invii tramite API possono essere abbinati ad automazioni Workflow di follow-up dopo l'invio o la firma del documento

Schermata 2 — Documenti e Contratti: API Pubbliche

List Templates

L'elenco dei template aiuta gli sviluppatori a recuperare i modelli di documento riutilizzabili disponibili in una location HITLEAD. È particolarmente utile quando il tuo sistema esterno deve consentire agli utenti di scegliere tra template approvati senza dover ricreare lo stesso contenuto ogni volta.

Puoi usare l'endpoint List Templates per:

  • Recuperare i record dei template disponibili in una location
  • Popolare un selettore di template in un'app esterna o in uno strumento interno
  • Verificare la disponibilità del template prima di generare un documento
  • Standardizzare la creazione ripetibile di documenti tra i team

Schermata 3 — Documenti e Contratti: API Pubbliche

Send Template

L'invio di un template ti permette di creare e inviare un documento da un template salvato in un'unica chiamata API. È una delle opzioni più utili per automatizzare proposte, accordi e altri tipi di documenti ripetibili, perché combina la generazione e la consegna del documento in un'unica azione.

Puoi usare l'endpoint Send Template per:

  • Generare un nuovo documento da un template
  • Inviare immediatamente il documento generato
  • Automatizzare Workflow ripetibili di contratti o proposte
  • Supportare la consegna personalizzata di documenti da Trigger o sistemi esterni

Questa opzione è spesso la migliore quando:

  • Utilizzi già template standardizzati in HITLEAD
  • Hai bisogno di un documento nuovo creato per ogni Contatto
  • Il tuo processo inizia al di fuori di HITLEAD ma deve comunque utilizzare l'infrastruttura documentale di HITLEAD

Come configurare le API Pubbliche di Documenti e Contratti

Una configurazione corretta garantisce che la tua integrazione possa autenticarsi in modo sicuro, utilizzare la location HITLEAD corretta e chiamare gli endpoint API giusti. Prima di iniziare a sviluppare, assicurati di capire se il tuo caso d'uso è meglio gestito tramite una Private Integration o tramite un'implementazione per sviluppatori più ampia supportata dalla piattaforma API di HITLEAD.

  1. Verifica che Documenti e Contratti faccia parte del tuo Workflow e che i documenti o i template necessari esistano già nella location HITLEAD corretta.
  2. Consulta l'attuale Documentazione API di HITLEAD per confermare il comportamento degli endpoint, i requisiti di autenticazione e i dettagli delle richieste. La documentazione ufficiale delle API è ora ospitata tramite il percorso di documentazione del Developer Marketplace.
  3. Scegli il metodo di autenticazione corretto per la tua integrazione. Le Private Integration sono destinate a connessioni interne sicure, mentre i flussi per sviluppatori in stile Marketplace possono utilizzare l'accesso basato su OAuth.
  4. Assicurati che le tue richieste API siano indirizzate al contesto di location HITLEAD corretto, in modo che i documenti e i template vengano recuperati dall'area account prevista.
  5. Testa il flusso di richiesta per l'azione specifica di cui hai bisogno:
    • List Documents
    • Send Document
    • List Templates
    • Send Template
  6. Se vuoi eseguire azioni dopo un invio, collega il tuo processo alle automazioni Workflow che rispondono agli eventi dei documenti, come inviato, visualizzato, firmato o completato.

Domande frequenti

D: Le API Pubbliche di Documenti e Contratti sono pensate per gli sviluppatori?

Sì. La funzionalità è progettata per un utilizzo programmatico, in particolare per i team che costruiscono integrazioni, automazioni o applicazioni personalizzate attorno ai Workflow documentali di HITLEAD.

D: Qual è la differenza tra Send Document e Send Template?

Send Document invia un documento esistente che si trova già in HITLEAD. Send Template crea un nuovo documento da un template e lo invia nella stessa richiesta.

D: Posso usare queste API al posto dei Workflow?

Sì, quando il tuo processo inizia al di fuori di HITLEAD o richiede una logica personalizzata. I Workflow sono spesso migliori per l'automazione no-code all'interno di HITLEAD, mentre le API sono più adatte alle integrazioni guidate dagli sviluppatori.

D: Queste API funzionano con i template già creati in HITLEAD?

Sì. Gli endpoint relativi ai template sono progettati per recuperare i template in una location e creare documenti da essi in modo programmatico.

D: Posso automatizzare i follow-up dopo l'invio di un documento?

Sì. Puoi abbinare gli invii tramite API ai Trigger di Workflow di Documenti e Contratti per automatizzare promemoria, notifiche interne o azioni successive in base allo stato del documento.

D: Ho bisogno delle Private Integration per usare queste API?

Non sempre. Le Private Integration sono un'opzione per i casi d'uso interni sicuri, ma HITLEAD supporta anche schemi di accesso per sviluppatori più ampi tramite la sua attuale piattaforma API e la documentazione del Marketplace.

D: Cosa significa "location" per questi endpoint?

Questi endpoint operano nel contesto della location HITLEAD pertinente, quindi i documenti e i template restituiti dall'API sono legati ai dati di quella location.

D: Posso gestire tutte le azioni sui documenti tramite queste API pubbliche?

L'articolo documenta specificamente le azioni di elenco e invio per documenti e template. Per la copertura più aggiornata degli endpoint, consulta sempre la documentazione ufficiale delle API.

Articoli correlati