Guida utente

API di Adobe Acrobat Sign - Domande frequenti

Cerca
Adobe Acrobat Sign

Adobe Acrobat Sign

Apri sul Web

 

Guida di Adobe Acrobat Sign

Novità

  1. Note sulla pre-release
  2. Note sulla versione
  3. Notifiche importanti

Introduzione

  1. Guida introduttiva per gli amministratori
  2. Guida introduttiva per gli utenti
  3. Per gli sviluppatori
  4. Libreria tutorial video
  5. Domande frequenti

Amministrazione

  1. Panoramica su Admin Console
  2. Gestione degli utenti
    1. Aggiungere, modificare e rivedere utenti attivi
      1. Rivedere gli utenti attivi dalla scheda Utenti
      2. Aggiungere un utente
      3. Aggiungere più utenti alla volta
      4. Aggiungere utenti dalla directory
      5. Aggiungere utenti da Microsoft Azure Active Directory
      6. Migra utenti tra organizzazioni admin console
    2. Creare utenti con funzioni specifiche
      1. Account tecnici: basati su API
      2. Account di servizio: gestiti manualmente
    3. Rivedere gli utenti che non hanno completato la verifica
    4. Verificare la presenza di utenti con errori di provisioning
    5. Modificare il nome/l’indirizzo e-mail
    6. Modificare l’iscrizione a un gruppo di un utente
    7. Modificare l’iscrizione a un gruppo di un utente tramite l’interfaccia del gruppo
    8. Promuovere un utente a un ruolo di amministratore
    9. Tipi di identità utente e SSO
    10. Cambiare l’identità utente
    11. Autenticare gli utenti con Microsoft Azure
    12. Autenticare gli utenti con la Federazione Google
    13. Profili di prodotti
    14. Esperienza di accesso 
  3. Impostazioni account/gruppo
    1. Panoramica delle impostazioni
    2. Impostazioni generali
      1. Livello e ID account
      2. Nuova esperienza del destinatario
      3. Flussi di lavoro per firma autonoma
      4. Invia in modalità collettiva
      5. Moduli web
      6. Flussi di lavoro di invio personalizzati
      7. Flussi di lavoro Power Automate
      8. Documenti libreria
      9. Raccogliere i dati modulo con gli accordi
      10. Visibilità limitata dei documenti
      11. Allegare una copia PDF dell’accordo firmato 
      12. Includere un collegamento nell’e-mail
      13. Includere un’immagine nell’e-mail
      14. Denominazione dei file allegati alle e-mail
      15. Allegare report di audit ai documenti
      16. Unire più documenti in uno solo
      17. Scaricare documenti singoli
      18. Caricare un documento firmato
      19. Delega per utenti nel mio account
      20. Consentire la delega ai destinatari esterni
      21. Autorizzazione a firmare
      22. Autorizzazione a inviare
      23. Autorizzazione all’aggiunta di sigilli elettronici
      24. Impostare un fuso orario predefinito
      25. Impostare un formato data predefinito
      26. Utenti in più gruppi
        1. Aggiornare per utilizzare la funzione Utenti in più gruppi
      27. Autorizzazioni amministratore gruppo
      28. Sostituzione del destinatario
      29. Report di audit
        1. Panoramica
        2. Consentire l’accesso non autenticato alla pagina di verifica delle transazioni
        3. Includere promemoria
        4. Includere eventi di visualizzazione
        5. Includere numero di pagine/allegati dell’accordo
      30. Piè di pagina transazione
      31. Messaggi e assistenza nel prodotto
      32. PDF accessibili
      33. Flussi di lavoro pdf/A
      34. Cliente nel settore sanitario
      35. Nuova esperienza di richiesta firme
      36. Nuova esperienza per flusso di lavoro personalizzato
      37. Nuova esperienza Crea modello
    3. Configurazione account / Impostazioni di branding
      1. Panoramica
      2. Aggiungere un logo
      3. Personalizzare nome host/URL dell’azienda    
      4. Aggiungere il nome dell’azienda
      5. Reindirizzamento URL post-accordo
    4. Preferenze firma
      1. Firme formattate correttamente
      2. Consentire ai destinatari di firmare
      3. I firmatari possono cambiare il nome
      4. Consentire ai destinatari di usare la propria firma salvata
      5. Personalizzare le Condizioni d’uso e l’Informativa cliente
      6. Guida per i destinatari ai campi del modulo
      7. Riavviare il flusso di lavoro dell’accordo
      8. Rifiuto di firmare
      9. Consentire flussi di lavoro con timbri
      10. Chiedere ai firmatari di fornire il proprio Titolo o Azienda
      11. Consentire ai firmatari di stampare e apporre una firma manuale
      12. Mostrare i messaggi durante la firma elettronica
      13. Chiedere ai firmatari di creare la firma con un dispositivo mobile
      14. Richiedere indirizzo IP dei destinatari
      15. Escludere il nome dell’azienda e il titolo dai timbri di partecipazione
      16. Applica un ridimensionamento adattivo del disegno della firma
    5. Firme digitali
      1. Panoramica
      2. Scaricare e firmare con acrobat 
      3. Firmare con le firme cloud
      4. Richiedi firme digitali per destinatario
      5. Includere metadati per provider dell’identità
      6. Provider per la firma cloud con restrizioni
    6. Sigilli elettronici
    7. Identità digitale
      1. Gateway di identità digitale
      2. Criterio di verifica identità
    8. Impostazioni report
      1. Abilita generazione rapporti classica
      2. Nuova esperienza per i report
      3. Impostazioni per report Classic
    9. Impostazioni di protezione
      1. Impostazioni Single Sign-on
      2. Impostazioni Ricordami
      3. Criterio password di accesso
      4. Forza password di accesso
      5. Durata sessione Web
      6. Tipo cifratura PDF
      7. API
      8. Accesso a informazioni su utenti e gruppi
      9. Intervalli IP consentiti
      10. Condivisione account
      11. Permessi di condivisione account
      12. Controlli di condivisione accordi
      13. Verifica identità firmatario
      14. Password per firma accordo
      15. Forza password del documento
      16. Blocca firmatari tramite geolocalizzazione
      17. Autenticazione tramite telefono
      18. Autenticazione basata su conoscenza (KBA)
      19. Consentire estrazione pagina
      20. Scadenza del link del documento
      21. Caricare un certificato client per webhook/richiamata
      22. Marca temporale
    10. Impostazioni di invio
      1. Espandere la pagina di invio dopo l'accesso
      2. Esperienze di creazione di accordi
      3. Richiedere il nome del destinatario all’invio
      4. Bloccare i valori dei nomi per gli utenti noti
      5. Ruoli destinatario consentiti
      6. Consentire e-Witnesses
      7. Gruppi di destinatari
      8. Cc
      9. Campi obbligatori
      10. Creazione di documenti allegati
      11. Appiattisci i campi
      12. Modificare gli accordi
      13. Rimuovi destinatari dagli accordi in corso
      14. Nome dell’accordo
      15. Lingue
      16. Messaggi privati
      17. Tipi di firma consentiti
      18. Promemoria
      19. Protezione con password di documenti firmati
      20. Invia notifica di invio accordo tramite
      21. Opzioni di identificazione firmatari
        1. Panoramica
        2. Password per firma
        3. Autenticazione basata su conoscenza
        4. Autenticazione tramite telefono
        5. Autenticazione tramite WhatsApp
        6. Password monouso tramite e-mail
        7. Autenticazione Acrobat Sign
        8. Firma digitale basata su cloud
        9. Autenticazione dell'identità digitale
        10. Documento di identità
        11. Report identità firmatario
      22. Compila i campi del modulo con dati verificati dall'identità
      23. Protezione contenuti
      24. Abilitare transazioni Notarize
      25. Scadenza documento
      26. Mostrare l’anteprima, posizionare le firme e aggiungere campi
      27. Ordine di firma
      28. Aggiungi me stesso
      29. Collegamento per scaricare l’accordo
      30. Bordi dei campi modulo
      31. Liquid Mode
      32. Controlli per flusso di lavoro personalizzato
      33. Opzioni di caricamento per la pagina di firma elettronica
      34. Reindirizzamento URL di conferma post-firma
      35. Limita l’accesso agli accordi condivisi
    11. Modelli messaggio
      1. Panoramica dei modelli di messaggio
      2. Creare nuovi modelli di messaggio
      3. Modificare Modelli di messaggio
      4. Eliminare Modelli di messaggio
    12. Impostazioni Bio-Pharma
      1. Panoramica
      2. Richiedere l’autenticazione dell’identità
      3. Motivi di firma
    13. Integrazione flusso di lavoro
    14. Impostazioni autenticazione
    15. Integrazione per pagamenti
    16. Messaggi per firmatari
    17. Impostazioni SAML
      1. Configurazione SAML
      2. Installare Microsoft Active Directory Federation Service
      3. Installare Okta
      4. Installare OneLogin
      5. Installare Oracle Identity Federation
    18. Governance dei dati
    19. Impostazioni marca temporale
    20. Archivio esterno
    21. Lingue account
    22. Impostazioni e-mail
      1. Immagini di intestazione/piè di pagina e-mail
      2. Consentire piè di pagina e-mail per singoli utenti
      3. Personalizzare l’e-mail Richiesta di firma
      4. Personalizzare i campi A e Cc
      5. Abilitare le notifiche senza collegamento
      6. Personalizzare i modelli e-mail
    23. Migrazione da echosign.com ad adobesign.com
    24. Configurare le opzioni per i destinatari
  4. Linee guida per i requisiti normativi
    1. Accessibilità
      1. Conformità alle norme di accessibilità
      2. Creare moduli accessibili con Acrobat desktop
      3. Creare moduli AcroForm accessibili
    2. HIPAA
    3. GDPR
      1. Panoramica sul GDPR
      2. Eliminare un utente
      3. Eliminare gli accordi di un utente    
    4. 21 CFR parte 11 ed EudraLex Annex 11
      1. Pacchetto di convalida 21 CRF parte 11
      2. Manuale 21 CFR ed EudraLex Annex 11
      3. Analisi delle responsabilità condivise
    5. Clientela del settore sanitario
    6. Supporto IVES
    7. Accordi di “archiviazione”
    8. Considerazioni UE/Regno Unito
      1. Operazioni transfrontaliere UE/Regno Unito e eIDAS
      2. Requisiti HMLR per atti firmati elettronicamente
      3. L’impatto della Brexit sulle leggi relative alla firma elettronica nel Regno Unito
  5. Download di accordi in modalità collettiva
  6. Richiedere il proprio dominio 
  7. Collegamenti Segnala abuso
  8. Requisiti di sistema e limitazioni
    1. Requisiti di sistema
    2. Limiti delle transazioni

Inviare, firmare e gestire gli accordi

  1. Opzioni destinatari
    1. Annullare un promemoria tramite e-mail
    2. Opzioni disponibili nella pagina di firma elettronica
      1. Panoramica della pagina di firma elettronica
      2. Aprire per leggere l’accordo senza campi
      3. Rifiutare di firmare un accordo
      4. Delegare autorizzazioni di firma
      5. Riavviare l’accordo
      6. Scaricare un file PDF dell’accordo
      7. Visualizzare la cronologia dell’accordo
      8. Visualizzare i messaggi dell’accordo
      9. Convertire una firma elettronica in una manuale
      10. Convertire una firma da manuale a elettronica
      11. Aggiungere i campi modulo
      12. Cancellare i dati dai campi modulo
      13. Navigazione e ingrandimento della pagina Firma elettronica
      14. Cambiare la lingua utilizzata nelle informazioni e negli strumenti per gli accordi
      15. Rivedere le note legali
      16. Regolare le preferenze dei cookie Acrobat Sign
  2. Inviare gli accordi  
    1. Pagina Invia (Composizione)
      1. Panoramica dei punti di riferimento e delle funzioni
      2. Selettore dei gruppi
      3. Aggiunta di file e modelli
      4. Nome accordo
      5. Messaggio globale
      6. Scadenza per completamento
      7. Promemoria
      8. Proteggere con password un PDF
      9. Tipo di firma
      10. Lingua del destinatario
      11. Ordine/flusso di firma dei destinatari
      12. Ruoli dei destinatari
      13. Autenticazione del destinatario
      14. Messaggio privato per il destinatario
      15. Accesso dei destinatari agli accordi
      16. Parti in Cc
      17. Controllo dell’identità
    2. Inviare un accordo solo a se stessi
    3. Inviare un accordo ad altri
    4. Firme manuali
    5. Ordine di firma del destinatario
    6. Invia in modalità collettiva
      1. Panoramica della funzione Invia in modalità collettiva
      2. Invio in modalità collettiva: configurare un modello principale
      3. Invio in modalità collettiva: configurare un file CSV
      4. Annullare una transazione per l’invio in modalità collettiva
      5. Aggiungere promemoria all’invio in modalità collettiva
      6. Reporting per Invia in modalità collettiva
  3. Authoring dei campi nei documenti
    1. Ambiente di authoring in-app
      1. Rilevamento automatico dei campi
      2. Trascinare i campi utilizzando l’ambiente di authoring
      3. Assegnare i campi modulo ai destinatari
      4. Ruolo di precompilazione
      5. Applicare campi con un modello per campi riutilizzabili
      6. Trasferire i campi in un nuovo modello libreria
      7. Ambiente di authoring aggiornato durante l’invio degli accordi
    2. Creare moduli e tag di testo
      1. Tag di testo - Panoramica
      2. Tag di testo - Nozioni di base e sintassi
      3. Tag di testo - Tipi di campo supportati
      4. Tag di testo - Esempi
      5. Tag di testo - Comportamenti avanzati
      6. Tag di testo - Campi calcolati
      7. Tag di testo - Risoluzione dei problemi
    3. Creare moduli con Acrobat (AcroForms)
      1. Creazione di AcroForm
      2. Creazione di file PDF accessibili
    4. Campi
      1. Tipi di campi
        1. Tipi di campi comuni
        2. Campi per firma elettronica
        3. Campo Iniziali
        4. Campo nome destinatario
        5. Campo e-mail destinatario
        6. Campo data della firma
        7. Campo di testo
        8. Campo data
        9. Campo numerico
        10. Casella di controllo
        11. Gruppo di caselle di controllo
        12. Pulsante di scelta
        13. Menu a discesa
        14. Sovrapposizione collegamenti
        15. Campo di pagamento
        16. Allegati
        17. Timbro di partecipazione
        18. Numero transazione
        19. Immagine
        20. Azienda
        21. Titolo
        22. Timbro
      2. Aspetto del contenuto dei campi
      3. Convalida dei campi
      4. Valori dei campi nascosti
      5. Impostazione delle condizioni Mostra/Nascondi
      6. Campi calcolati 
      7. Moduli verificati
    5. Domande frequenti sull’authoring
  4. Firmare gli accordi
    1. Firmare gli accordi ricevuti
    2. Compila e firma
    3. Firma autonoma
  5. Gestire gli accordi
    1. Panoramica della pagina Gestisci
    2. Copia un accordo
    3. Delegare gli accordi
    4. Sostituire i destinatari
    5. Limitare la visibilità del documento 
    6. Annullare un accordo 
    7. Creare nuovi promemoria
    8. Revisione dei promemoria
    9. Annullare un promemoria
    10. Accedere ai flussi Power Automate
    11. Altre azioni...
      1. Come funziona la ricerca
      2. Visualizzare un accordo
      3. Creare un modello da un accordo
      4. Nascondere/Mostrare gli accordi nella visualizzazione
      5. Caricare un accordo firmato
      6. Modificare i file e i campi di un accordo inviato
      7. Modificare il metodo di autenticazione di un destinatario
      8. Aggiungere o modificare una data di scadenza
      9. Aggiungere una nota a un accordo
      10. Condividere un singolo accordo
      11. Annullare la condivisione di un accordo
      12. Scaricare un singolo accordo
      13. Scaricare i singoli file di un accordo
      14. Scaricare il report di audit di un accordo
      15. Scaricare il contenuto dei campi di un accordo
  6. Report di audit
  7. Rapporti ed esportazioni di dati
    1. Panoramica
    2. Concedere agli utenti l’accesso al reporting
    3. Grafici del report
      1. Creare un nuovo report
      2. Report degli accordi
      3. Report sulle transazioni
      4. Impostazioni report di attività
      5. Modificare un report
    4. Esportazioni di dati 
      1. Creare una nuova esportazione di dati
      2. Esportazione di dati da moduli web
      3. Modificare un’esportazione di dati
      4. Aggiornare il contenuto dell’esportazione di dati
      5. Scaricare l’esportazione di dati
    5. Rinominare un report o un’esportazione
    6. Duplicare un report o un’esportazione
    7. Pianificare un report o un’esportazione
    8. Eliminare un report o un’esportazione
    9. Verificare l’utilizzo delle transazioni

Funzionalità e flussi di lavoro avanzati per gli accordi

  1. Moduli web 
    1. Creare un modulo web
    2. Modificare un modulo web
    3. Abilitare/Disabilitare un modulo web
    4. Nascondere/Mostrare un modulo Web
    5. Trovare l’URL o il codice script 
    6. Precompilare i campi dei moduli web con i parametri URL
    7. Salvare un modulo Web da completare in un secondo momento
    8. Ridimensionare un modulo web
  2. Modelli riutilizzabili (Modelli libreria) 
    1. Moduli per la Pubblica amministrazione degli Stati Uniti nella libreria Acrobat Sign
    2. Creare un modello libreria
    3. Modificare il nome di un modello libreria
    4. Modificare il tipo di un modello libreria
    5. Modificare il livello di autorizzazione di un modello libreria
    6. Copiare, modificare e salvare un modello condiviso
    7. Scaricare i dati dei campi aggregati per un modello libreria
  3. Trasferire la proprietà dei moduli web e dei modelli libreria
  4. Flussi di lavoro Power Automate 
    1. Panoramica dell’integrazione Power Automate e diritti inclusi
    2. Abilitare l’integrazione di Power Automate
    3. Azioni nel contesto sulla pagina Gestisci
    4. Tracciare l’utilizzo di Power Automate
    5. Creare un nuovo flusso (esempi)
    6. Trigger utilizzati per i flussi
    7. Importazione di flussi dall’esterno di Acrobat Sign
    8. Gestire i flussi
    9. Modificare i flussi
    10. Condividere i flussi
    11. Disabilitare o abilitare i flussi
    12. Eliminare i flussi
    13. Modelli utili
      1. Solo per l’amministratore
        1. Salvare tutti i documenti completati in SharePoint
        2. Salvare tutti i documenti completati in OneDrive for Business
        3. Salvare tutti i documenti completati in Google Drive
        4. Salvare tutti i documenti completati in DropBox
        5. Salvare tutti i documenti completati in Box
      2. Archiviazione dell’accordo
        1. Salvare i documenti completati in SharePoint
        2. Salvare i documenti completati in One Drive for Business
        3. Salvare i documenti completati in Google Drive
        4. Salvare i documenti completati in Dropbox
        5. Salvare i documenti completati in Box
      3. Archiviazione del modulo web dell’accordo
        1. Salvare i documenti dei moduli web completati nella libreria di SharePoint
        2. Salvare i documenti dei moduli web completati in OneDrive for Business
        3. Salvare i documenti completati in Google Drive
        4. Salvare i documenti dei moduli web completati in Box
      4. Estrazione di dati dall’accordo
        1. Estrarre i dati del campo modulo dal documento firmato e aggiornare un foglio Excel
      5. Notifiche per l’accordo
        1. Inviare notifiche e-mail personalizzate con i contenuti dell’accordo e l’accordo firmato
        2. Ricevere le notifiche di Adobe Acrobat Sign in un canale Teams
        3. Ricevere le notifiche di Adobe Acrobat Sign in Slack
        4. Ricevere le notifiche di Adobe Acrobat Sign in Webex
      6. Generazione degli accordi
        1. Generare un documento da modulo Power App e modello Word e inviarlo per la firma
        2. Generare un accordo da un modello Word in OneDrive e ottenere la firma
        3. Generare un accordo per la riga Excel selezionata, inviarlo per revisione e firma
  5. Flussi di lavoro di invio personalizzati
    1. Panoramica del flusso di lavoro di invio personalizzato
    2. Creazione di un nuovo flusso di lavoro di invio
    3. Modificare un flusso di lavoro di invio
    4. Attivare o disattivare un flusso di lavoro di invio
    5. Inviare un accordo con un flusso di lavoro di invio
  6. Condividere utenti e accordi
    1. Condividere un utente
    2. Condividere gli accordi

Integrazione con altri prodotti

  1.  Panoramica delle integrazioni di Acrobat Sign 
  2. Acrobat Sign per Salesforce
  3. Acrobat Sign per Microsoft
    1. Acrobat Sign per Microsoft 365
    2. Acrobat Sign per Outlook
    3. Acrobat Sign per Word/PowerPoint
    4. Acrobat Sign per Teams
    5. Acrobat Sign per Microsoft PowerApps e Power Automate
    6. Connettore Acrobat Sign per Microsoft Search
    7. Acrobat Sign per Microsoft Dynamics 
    8. Acrobat Sign per Microsoft SharePoint 
  4. Altre integrazioni
    1. Acrobat Sign per ServiceNow
    2. Acrobat Sign per HR ServiceNow
    3. Acrobat Sign per SAP SuccessFactors
    4. Acrobat Sign per Workday
    5. Acrobat Sign per NetSuite
    6. Acrobat Sign per VeevaVault
    7. Acrobat Sign per Coupa BSM Suite
  5. Integrazioni gestite dai partner
  6. Come ottenere una chiave di integrazione

Acrobat Sign per sviluppatori

  1. API REST 
    1. Documentazione sui metodi
    2. SDK/Guida per gli sviluppatori
    3. Domande frequenti sulle API    
  2. Webhook 
    1. Panoramica del webhook
    2. Configurare un nuovo webhook
    3. Visualizzare o modificare un webhook
    4. Disattivare o riattivare un webhook
    5. Eliminare un webhook
    6. Certificati SSL bidirezionali
    7. Webhook nell’API
  3. Sandbox
    1. Panoramica della sandbox
    2. Collegare produzione e sandbox
    3. Tipi di risorse sandbox

Supporto e risoluzione dei problemi

  1. Risorse di Assistenza clienti 
  2. Risorse per Enterprise Customer Success 

L’accesso alle API è riservato esclusivamente agli account di livello Enterprise e Sviluppatore.

Collegamenti alla documentazione di base

API REST 6 - Collegamenti utili:

Nota:

Il supporto per le API SOAP precedenti è terminato a maggio 2021.

Tutti i clienti che utilizzano le API SOAP devono migrare alle API REST il prima possibile.

Una volta effettuato l'accesso, vai a\u00a0API Acrobat Sign > Informazioni API > API REST e documentazione.
\n

Accedere ad Acrobat Sign


Aspetti generali

Non è possibile creare il documento visualizzando la pagina nell’interfaccia utente Web, tramite trascinamento o assegnando ruoli firmatari utilizzando transientDocumentId tramite API.

La chiamata transientDocuments restituisce transientDocumentID, valido per 7 giorni.  Puoi utilizzarlo solo per le chiamate API successive. Viene memorizzato nel server API e gli viene assegnato questo ID. Carica un file e fai riferimento al suo ID nelle ulteriori chiamate API.

Non puoi caricare direttamente un documento in Accordo utilizzando le API REST.

In base al requisito REST, devi prima creare un documento transitorio e quindi utilizzare questo ID nei metodi Agreement, Widget o Library come origine del file.

Il documento transitorio è un file di origine raw, ad esempio PDF, doc o docx, caricato sui server di Adobe. Pertanto, questo è un modo pratico per trasmettere il documento di base ai server API e un documento transitorio sul Web.

Sì, puoi pubblicare gli accordi utilizzando i flussi di lavoro nella versione 6 utilizzando la chiamata API POST /agreements. Trasmetti il parametro workflowId nella chiamata API.

Puoi ottenere l’ID workflowId di un flusso di lavoro utilizzando la chiamata GET /workflows.

  1. Accedi ad Acrobat Sign come amministratore.

  2. Vai a\u00a0API Acrobat Sign > Registro richieste API.

    La pagina Registri richieste API con diversi record visualizzati.

  1. \u00a0Accedi ad Acrobat\u00a0Sign come amministratore

  2. Vai a: API Acrobat\u00a0Sign\u00a0>\u00a0Informazioni API

  3. Seleziona il collegamento\u00a0Esempi API REST\u00a0.

    Nota:

    Per scaricare l’SDK JavaScript, vedi https://github.com/adobe-sign/AdobeSignJsSdk.

    La pagina Informazioni API che evidenzia il collegamento Esempi API REST.

A partire dalla versione 6, l’opzione “sendTroughWeb” non è più disponibile. È sostituita da state. Si tratta dello stato a cui arriva l’accordo. Il campo “state” può essere fornito solo nelle chiamate POST. Non viene mai restituito in GET /agreements/{ID} e viene ignorato se fornito nella chiamata PUT /agreements/{ID}. Lo stato finale dell'accordo può essere ottenuto da\u00a0GET\u00a0/agreements/ID.
\n
\nstate(stringa) = ['AUTHORING' o 'DRAFT' o 'IN_PROCESS'].
\n
\nAUTHORING\u00a0consente a un Utente di\u00a0authoring\u00a0i documenti di un accordo prima di inviarli.L’operazione di creazione in questo caso si riferisce alla creazione, modifica o inserimento di campi modulo con le relative configurazioni (assegnatario, condizioni, tipo di dati, ecc.). nei documenti dell’accordo. Dopo aver pubblicato il documento nello stato Authoring, il documento è visibile nella sezione Bozza della scheda Gestisci di Acrobat Sign.

DRAFT è una fase temporanea o primitiva della risorsa finale prevista che può essere aggiornata a più riprese per creare la risorsa finale e non è visibile nella sezione Bozza della scheda Gestisci di Acrobat Sign.Utilizzando lo stato Bozza, le informazioni del set di partecipanti non sono obbligatorie e possono essere assegnate in seguito durante l’esecuzione della chiamata PUT /agreement/agreementId per completare la bozza.\u00a0Questo passaggio può essere ripetuto più volte finché non hai tutti i dati necessari per creare l'accordo.
\n
\nIN_PROCESS\u00a0cambia lo stato dell'accordo in In attesa di firma ed è visibile nella sezione In attesa di firma della scheda Gestisci di Acrobat\u00a0Sign.

sendThroughWeb consente di inviare l’accordo in modo interattivo. I vari parametri nel campo "options" nella richiesta v5 POST /agreements consentono all'Utente di configurare questa vista interattiva (pagina Invia).Tutti questi parametri di configurazione della pagina come fileUploadOptions sono spostati nell'API POST agreements/ID/views.

Quindi in effetti, puoi ottenere sendThroughWeb creando un accordo nello stato AUTHORING tramite l'API POST /agreements.Quindi, per richiedere l’URL della pagina successiva nella configurazione desiderata, chiama l’API POST agreements/ID/views.

Procedi come segue:

1. Vai alla documentazione API REST V6 e seleziona il metodo POST/agreements.
\n2. Usa il seguente codice di richiesta:

{

  "fileInfos": [

    {

      "transientDocumentId": "***************************"

    }

  ],

  "name": "test",

  "participantSetsInfo": [

    {

      "memberInfos": [

        {

          "email": "abc@gmail.com"

        }

      ],

      "order": 1,

      "role": "SIGNER"

    }

  ],

  "signatureType": "ESIGN",

  "state": "AUTHORING"

}

 

3. Ora, usa il metodo post /agreements/{agreementId}/views con il seguente codice di richiesta:

 

{

  "name": "AUTHORING"

}

Il codice di risposta fornisce l’URL per i campi di creazione.

È possibile definire l’URL di richiamata nei modi seguenti:

  • Usa il parametro seguente per definire l’URL di richiamata in base alle esigenze:

    "callbackInfo": "",
  • Contatta il supporto Adobe Acrobat Sign per impostare l'URL di callback predefinito per l'intero account.

L’interfaccia utente SOAP (SmartBear) riceve un errore di connessione SSL simile al seguente, che viene generato quando si effettua una chiamata API. Questo errore si verifica in genere se si utilizza un protocollo SSL o TLS obsoleto precedente a TLS1.2.

ERRORE: Eccezione nella richiesta: javax.net.ssl.SSLException: Ricevuto avviso irreversibile: protocol_version
ERRORE: Si è verificato un errore [Ricevuto avviso irreversibile: protocol_version], per i dettagli consulta il registro degli errori.

  1. Aggiungi (-Dsoapui.https.protocols=SSLv3,TLSv1.2) nel file VMOPTIONS nella cartella Bin.

  2. Passa a C:\Programmi\SmartBear\SoapUI-5.2.1\bin (o altra, in base alla posizione in cui è stata installata l’interfaccia SOAP). Potrebbe essere in C:\Programmi (x86)

  3. Nel file VMOPTIONS, abilita per il file l’autorizzazione completa di lettura/scrittura.

    VMOPTIONS

  4. Fai clic con il pulsante destro del mouse sul file VMOPTIONS, quindi scegli Proprietà, passa alla scheda Sicurezza, seleziona l’utente e fai clic su Modifica. L’icona Controllo accesso utente viene visualizzata sul pulsante Modifica. Seleziona tutte le caselle di controllo e fai clic su OK.

  5. Ripeti la stessa procedura per Amministratori, Sistemi e tutti i pacchetti di applicazioni.

  6. Apri il file con Blocco note.

  7. In fondo, aggiungi questo protocollo: “-Dsoapui.https.protocols=SSLv3,TLSv1.2” e salva le modifiche.

  8. Chiudi l’interfaccia SOAP e riavvia. Quando fai la chiamata API, ora funziona senza errori SSL. Esegui una chiamata ping di prova per controllare.

Di seguito sono riportati i passaggi per creare l'ID client e il segreto client nell'applicazione Acrobat Sign:

  1. Accedi ad Acrobat Sign come amministratore.

  2. Vai a API Acrobat Sign > Applicazioni API.

  3. Per creare un'app, seleziona l'icona più ( + ).

    Pagina Applicazioni API con l'icona Crea evidenziata

  4. Immetti il Nome e il Nome visualizzato.

  5. In Dominio, seleziona CUSTOMER.

    Salva la configurazione.

    Il modulo di creazione dell'applicazione con il dominio CUSTOMER evidenziato.

  6. Seleziona l'app per visualizzare le azioni disponibili per l'utente.

  7. Seleziona Configura OAuth per l'applicazione.

    La pagina Applicazioni API con un'applicazione selezionata, che mostra il collegamento dell'azione «Configura OAuth per l'applicazione»

  8. Immetti l’URI di reindirizzamento.

  9. Seleziona le caselle di controllo per ogni ambito che devi abilitare e definisci se l'ambito è limitato all'utente (self), al gruppo o all'account.

     

    Il pannello Configura OAuth con il menu a discesa Modificatore espanso.

  10. Salva la configurazione.

  1. Accedi ad Acrobat Sign come amministratore dell'account.

  2. Vai a: Acrobat Sign API > Informazioni API

  3. Fai sul collegamento Chiave di integrazione.

    La pagina Informazioni API che evidenzia il collegamento Chiave di integrazione

    Nota:

    Se non vedi il collegamento Chiave di integrazione, contatta il Supporto per abilitare il tuo account.

    • Assegna un nome alla chiave utilizzando un valore intuitivo.
    • Seleziona i vari ambiti necessari in base alla funzione dell’applicazione.
    • Una volta completata la configurazione della chiave, fai clic su Salva.
    Interfaccia Crea chiave di integrazione

  5. Una volta salvata, la chiave si trova in: Preferenze personali > Token di accesso

    Vengono elencati il nome della chiave e tutti gli ambiti attivati.  

    Seleziona la descrizione della chiave per visualizzare i collegamenti delle azioni:

    • Chiave di integrazione: questo collegamento fornisce la chiave letterale. 
    • Revoca: questo collegamento revoca ed elimina definitivamente il token di accesso.
    Token di accesso - Chiave di integrazione

  1. Accedi ad Acrobat Sign come amministratore.

  2. Vai a Acrobat Sign API > Applicazioni API.

  3. Seleziona la tua app per visualizzare le azioni disponibili.

    Pagina Applicazioni API con un'app selezionata

  4. Seleziona Configura OAuth per l'applicazione.

    La pagina Applicazioni API con un'applicazione selezionata, che mostra il collegamento dell'azione «Configura OAuth per l'applicazione»

  5. Genera il codice di autorizzazione utilizzando il seguente collegamento. L'ID client, l'URI di reindirizzamento e gli ambiti devono essere gli stessi dell'URL seguente come selezionato nell'app (evita spazi nell'URL seguente e lo Shard come 'NA1' è in base all'account Acrobat Sign di appartenenza):

    https://secure.na1.echosign.com/public/oauth?redirect_uri=https://www.google.co.in&response_type=code&client_id=CBJCHBCAABAAo9FZgq31_5BVG_kcIXEe6gNtn-R-gdNe&scope=user_login:self+agreement_send:account

    Configurare OAuth per Postman

  6. Se la chiamata ha esito positivo, preleva il codice di autorizzazione dalla barra degli indirizzi.

    Fnord.

  7. Scarica e installa Postman dal collegamento https://www.getpostman.com/apps.

  8. Una volta scaricato e installato, seleziona NEW per creare un POST.

  9. Inserisci il collegamento https://secure.na1.adobesign.com/oauth/token a cui appartiene il tuo account Acrobat Sign.

  10. In Headers, immetti Content-Type come application/x-www-form-urlencoded.

  11. Assicurati che x-www-form-urlencoded sia selezionato in Body e immetti i parametri seguenti con i valori corrispondenti dall'app creata nell'account Acrobat Sign, quindi fai clic su SEND.

    Fnord.

  12. Se tutte le informazioni sono corrette, nella risposta vengono restituiti il token di accesso e il token di aggiornamento:

    Fnord.

Durante l’esecuzione del processo OAuth:

1. L'ID client e l'URI di reindirizzamento sono corretti.
2. Gli ambiti forniti nell'URL di autorizzazione devono corrispondere esattamente agli ambiti forniti nell'app Acrobat Sign.
3. Usa lo shard corretto (na1, na2, au1, eu1, jp1) in base all'account che viene configurato.
4. Rimuovi eventuali spazi presenti nell'URL di autorizzazione.
5. Controlla la sintassi dell'URL di autorizzazione:

https://secure.na1.echosign.com/public/oauth?redirect_uri=https://secure.na1.echosign.com/public/oauthDemo&
response_type=code&client_id=9MEJXY4Y4R7L2T&scope=agreement_send

I token di accesso sono validi solo per 3600 secondi (1 ora), dopodiché scadono.

Il titolare della richiesta API può utilizzare i token di aggiornamento per generare nuovi token di accesso in base alle esigenze.

I webhook sono supportati in API REST v6 e versioni successive.

Se un ricevitore di webhook non risponde entro 72 ore, il webhook viene disabilitato e non viene inviata alcuna notifica.

Se l'URL target per il webhook non è disponibile per qualsiasi motivo, Acrobat Sign mette in coda il JSON e riprova la notifica push in un ciclo progressivo per 72 ore.

Gli eventi non consegnati vengono mantenuti in una coda di tentativi e nelle successive 72 ore verrà fatto il possibile per inviare le notifiche nell’ordine in cui si sono verificate.

La strategia con sui viene nuovamente tentato di consegnare le notifiche prevede il raddoppiamento del tempo tra tentativi successivi, a partire da un intervallo di 1 minuto che aumenta fino a 12 ore, per un totale di 15 tentativi nell’arco di 72 ore.

 

Per creare un webhook direttamente dall'interfaccia utente di Acrobat Sign, crea prima l'URL del webhook tramite le app per le funzioni di Azure AD seguendo questi passaggi:

  1. Accedi dall’account Microsoft https://portal.azure.com/.

  2. Registrati per le App per le funzioni nell’account Azure AD.

    Menu di Azure

  3. Passa ad Azure AD, seleziona App per le funzioni e fai clic sull’icona + per Funzioni.

  4. Seleziona Webhook e API con il linguaggio JavaScript e fai clic su Crea funzione.

    Interfaccia API di Azure

  5. Sostituisci il file Index.js con lo snippet di codice seguente:

    module.exports = function (context, req) { 
    var clientId = req.headers['x-adobesign-clientid']; 
    // Validate that the incoming ClientID is genuine 
    if (clientId === '************************************') { 
        context.res = { 
            // status: 200, /* Defaults to 200 */ // any 2XX response is acceptable 
            body: { 
                'xAdobeSignClientId' : clientId, 
                 
            }, 
            headers : { 
                'Content-Type' : 'application/json' 
            } 
        }; 
    } 
    else { 
        context.res = { 
            status: 400, 
            body: "Opps!! Illegitimate Call identified" 
        }; 
    } 
    context.done(); 
};

  6. Fai clic sul pulsante Prova nell’angolo a destra e fornisci la seguente intestazione:

    X-AdobeSign-ClientId as ***********************

    Provare l’API

  7. Seleziona Salva e Esegui.

  8. Dopo aver ricevuto la risposta “200 OK” con l’intestazione seguente, fai clic su Ottieni URL funzione

    Risposta 200

  9. Copia l'URL e vai all'interfaccia Acrobat Sign > Webhooks > Fai clic sull'icona + per creare.

  10. Immetti i dati seguenti: 

    • Nome: scegli un nome intuitivo che altri amministratori possono facilmente riconoscere.
    • Ambito: ampiezza della rete che deve essere coperta dal webhook. Account e Gruppo sono disponibili nell'interfaccia.
      L’API supporta gli ambiti Account, Gruppo, Utente e Risorsa.
    • È possibile definire un solo ambito per webhook.
    • URL: L'URL di destinazione a cui Acrobat Sign ha inviato il payload JSON.
    • Eventi: I trigger che fanno sì che Acrobat Sign generi il JSON e lo invii all'URL.
      Ogni evento genera un payload diverso pertinente all'evento trigger
      Più eventi possono essere inclusi in un webhook.
    • Parametri di notifica: i parametri di notifica identificano le sezioni del payload JSON dell’evento e consentono di selezionare solo le sezioni dell’evento che ritieni importanti.
    Interfaccia utente Webhook

  11. Una volta definito il webhook, fai clic su Salva: il nuovo webhook inizia subito a reagire agli eventi trigger.

La risorsa dell'accordo si riferisce a una risorsa tramite la quale puoi creare un accordo, ad esempio documento di libreria, widget e accordo stesso.

Per cercare eventi di risorse dell'accordo, fai prima una richiesta all'API che crea agreementAssetEvents con parametri di ricerca pertinenti.

La risposta è la prima pagina di risultati insieme a un parametro ID di ricerca e cursore della pagina successiva. Puoi usarlo per recuperare ulteriori risultati di pagina se disponibili mediante l’API, che recupera agreementAssetEvents in base all’ID di ricerca.

  1. Apri la documentazione delle API REST per la versione 5.

  2. Passa a POST /search/agreementAssetEvents e genera il token di accesso con gli ambiti pertinenti.

  3. Nel codice della richiesta, definisci la data di inizio e di fine in base al requisito:

    { 
  "endDate": "2018-05-22T22:33:33", 
  "startDate": "2017-12-22T22:33:33" 
}

  4. Fai clic su Try it Out per provarlo. Vengono recuperati gli ID delle risorse dell’accordo, che possono essere utilizzati anche come ID accordo.


Gestione degli utenti e dell’account

  1. Accedi ad Acrobat Sign.
  2. Vai alla documentazione di Acrobat Sign API > REST API .
  3. Seleziona Versione 5.
  4. Nel metodo POST /users, usa il codice di richiesta descritto per il
    metodo UserCreationInfo
    {
    "email": "email@email.com",
    "firstName": "AA",
    "lastName": "AB",
    "password":"12******rte"
    }

Gli account Acrobat Sign che utilizzano Admin Console (Adobe One) per gestire le autorizzazioni utente non possono utilizzare l'API Acrobat Sign per creare utenti o gestirli.

L'admin console Adobe One utilizza un'API diversa dall'API acrobat sign . Per ulteriori informazioni, consulta questi articoli:

 

Ottenere l’ID di un gruppo:

  1. Passa a https://secure.na1.echosign.com/public/docs/restapi/v5.

  2. In Risorse e operazioni, fai clic su groups.

  3. Fai clic su GET /groups.

  4. Fai clic sul pulsante OAuth Access-token.

  5. Genera il token di accesso.

  6. Fai clic sul pulsante Try it out per provarlo.

    Riceverai una risposta simile alla seguente, con il nome e l’ID del gruppo:

    { 
  "groupInfoList": [ 
    { 
      "groupId": "3AAABLblqZhB4o9EnlvmGB_m8CrG5O6XClTBO7vmojOOexu5r3G95LtEV2Sp7BuhNvQYSvWB7PmmwVPXnhPIiYSuHV98Cerkp", 
      "groupName": "Default Group" 
    }, 
    { 
      "groupId": "3AAABLblqZhC3dPT6za5h7r1-BOEWivCe_OcAVONhcsKa57SL9_iCwGr5v_JED1No5jE20Pcjv0mYH2J-LoY1AcmqS69vRkO7", 
      "groupName": "test" 
    }, 
  ] 
}

Eliminazione di un gruppo:

  1. Fai clic su DELETE /groups/{groupId}.

  2. Per generare il token di accesso, fai clic sul pulsante OAuth Access-token.

  3. Nella casella groupId, inserisci il groupId ricevuto nella risposta della chiamata precedente e che desideri eliminare.

  4. Fai clic su Try it Out per provarlo.

    Una volta eliminato il gruppo, riceverai una risposta simile alla seguente: Nessun contenuto

Nota:

Non è possibile eliminare un gruppo a cui è assegnato un utente. È possibile eliminare solo gruppi vuoti. Ricevi una risposta come la seguente se è presente un utente nel gruppo.


{

  "code": "GROUP_NOT_EMPTY",

  "message": "Impossibile eliminare il gruppo perché non è vuoto."

}


Avvio e invio di accordi

Generazione di un documento transitorio

  1. Passa a: https://secure.na1.adobesign.com/public/docs/restapi/v6

  2. Fai clic su transientDocuments ed espandi il metodo POST /transientDocuments.

  3. Fai clic sul pulsante OAuth Access-token.

    Metodo API transientDocument

    • Abilita gli ambiti (Scopes) per la transazione.
    • Fai clic su Authorize.
    Ambiti OAuth

  5. Consenti accesso

    Se richiesto, fai clic su Consenti accesso.

  6. Viene visualizzata nuovamente la pagina dei metodi API. Il valore Autorizzazione è ora compilato.

    • Immetti il nome file nel campo File-Name.
    • Fai clic sul pulsante Choose File per scegliere e caricare il documento per l’accordo.
    • Fai clic su Try it out! .
    Try it out!

  7. Viene generata la risposta.

    Il transientDocumentID si trova nel corpo della risposta:

    ID documento transitorio

Generazione di un accordo mediante il documento transitorio

  1. Passa a: https://secure.na1.adobesign.com/public/docs/restapi/v6

  2. Fai clic su agreements ed espandi il metodo POST /agreements.

    • Fai clic sul pulsante OAuth Access-token.
    • Abilita l’ambito OAuth.
    • Fai clic su Authorize.
      • Se richiesto, fai clic su Consenti accesso.

  4. Viene visualizzata nuovamente la pagina dei metodi API. Il valore Autorizzazione è ora compilato.

    • Copia lo script seguente in un editor di testo (questo script è solo un esempio con configurazioni minime; il codice di produzione sarà diverso).
    •  Inserisci il valore trasientDocumentId nel codice, dove è indicato.
    { 
  "fileInfos": [ 
   {"transientDocumentId":"PASTE YOUR TRANSIENTDOCUMENTID HERE"} 
  ], 
  "name": "test doc", 
  "participantSetsInfo": [ 
    { 
      "memberInfos": [ 
        { 
          "email": "noreply@echosign.com" 
        } 
      ], 
      "order": 1, 
      "role": "SIGNER" 
    } 
  ], 
  "signatureType": "ESIGN", 
  "state": "DRAFT" 
}

     

    • Copia lo script personalizzato e incollalo nel campo AgreementInfo.
    • Fai clic su Try it out! .
    Metodo POST agreement

  5. Viene generata la risposta.

    Il codice agreementID si trova nel corpo della risposta:

    Risposta del metodo POST agreement

Di seguito viene descritto come aggiungere dei file al parametro FileInfo:

  1. Utilizza l’ID transitorio:

    Vai a POST/transientDocuments e carica il documento da utilizzare dal computer locale.
    Utilizza l'ID temporaneo generato nella sezione File Info in POST/Agreements:

    "fileInfos": [ 
     { 
       "transientDocumentId": "" 
     } 
   ],

  2. Utilizza l’ID documento libreria:

    Passa al dashboard. Fai clic su Aggiungi documento alla libreria e salva il modello.
    In REST API Documentation, fai clic su GET /libraryDocuments e recupera l'ID libreria per il modello che stai creando.
    In POST/Agreements, fornisci l'ID del documento della libreria:

    "libraryDocumentId": "", 
  "libraryDocumentName": "",

  3. Utilizza un URL pubblico:

    Specifica l’URL accessibile al pubblico da utilizzare nel parametro FileInfo:

    { 
      "documentURL": { 
        "mimeType": "", 
        "name": "", 
        "url": "" 
      },

  1. Passa a: https://secure.na1.adobesign.com/public/docs/restapi/v6.

  2. Seleziona l’opzione Agreements > POST/agreements. 

  3. Seleziona l’opzione OAuth Access-Token e specifica gli ambiti necessari.

  4. Una volta aggiunto il token di accesso, è possibile utilizzare il seguente codice di richiesta:

    { 
"documentCreationInfo": { 
     "recipientSetInfos": [ 
          { 
               "recipientSetRole": "SIGNER", 
               "recipientSetMemberInfos": [{"email": "testemail@email.com"}] 
          }, 
          { 
               "recipientSetRole": "SIGNER", 
               "recipientSetMemberInfos": [{"email": "testemail@email.com"}] 
          } 
     ], 
     "signatureFlow": "SEQUENTIAL", 
     "name": "husband wife", 
     "signatureType": "ESIGN", 
     "fileInfos": [ 
{ 
"transientDocumentId": "(SAMPLE VALUE)3AAABLblqZhAJ9H6e23kZAfBUbItPvIhHTEyA6eZhziEp4KSntYcULpo43OEXwuWiWa-IM1r1EExYW0044CjCkliP4WFL5yKBUDq5DYSmSxVlFypcD0at8kK-BX-Mu3T9c_3GUqgDg0ArX0MmzWT72GLR_0M4Jq--mtuqGzq-VK1s-WGR6GcbedVY7XWAf3b3h-SpE08Hc-iF3zO7jQzi9newXSl-iW2JJsb_55tggkyxkXAkj74C1WD6KkJzgblK0JU-seh6QPDd0Fv6_mfQe2EPQA31nXj50aXwD_xlUBq7mg5FeaBnZ5bzgoqIWGHkbyeD2taaFdw*"} 
] 
} 
}

Nella chiamata POST /agreements, per il parametro signatureflow puoi passare il valore SENDER_SIGNS_FIRST o SENDER_SIGNS_LAST per aggiungere il mittente come primo o ultimo firmatario rispettivamente.

Ecco un esempio della chiamata in formato JSON:

{

  "documentCreationInfo": {

    "fileInfos": [

      {        "transientDocumentId":"3AAABLblqZ-yourIDGoesHere"

      }

    ],

    "name": "Test",

    "recipientSetInfos": [

      {

        "recipientSetMemberInfos": [

          {

            "email": "test@email.com"

          }

        ],

        "recipientSetRole": "SIGNER"

      }

    ],

    "signatureType": "ESIGN",

    "signatureFlow": "SENDER_SIGNS_FIRST"

  }

}

Nota:

L'opzione per Send on behalf è disponibile solo in REST API V6 con Advanced sharing attivato.

Se l'autorizzazione Send non è fornita nella condivisione o se Advance Sharing non è abilitato, ricevi una risposta come la seguente:

 

{"code":"PERMISSION_DENIED","message":"User provided in x-on-behalf-of-user header does not have required permission to perform this operation."}

 

Per la funzione “Invia per conto di”, abilita Condivisione account avanzata affinché gli utenti possano concedere autorizzazioni di invio ad altri utenti durante la condivisione del proprio account. Per Advanced sharing, consulta Enabling Advanced account Sharing.

Una volta abilitata la condivisione utente, segui questi passaggi per Send on behalf:

Generazione di un documento transitorio:

  1. Passa a https://secure.adobesign.com/public/docs/restapi/v6.

  2. In transientDocuments, fai clic su POST /transientDocuments.

  3. Per generare un token di autorizzazione, fai clic sul pulsante OAUTH ACCESS-TOKEN.

  4. In x-on-behalf-of-user, specifica l’e-mail dell’utente per conto del quale si desidera inviare, nel formato seguente: email:test@email.com

  5. Per selezionare un file, fai clic su Choose File, quindi su Try it Out.

    Viene ricevuta una risposta simile alla seguente con transientDocumentId:

    {"transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*"}

Generazione di un accordo mediante il documento transitorio:

  1. In agreements, fai clic su POST /agreements.

  2. Per generare un token di autorizzazione, fai clic sul pulsante OAUTH ACCESS-TOKEN.

  3. In x-on-behalf-of-user, specifica l’e-mail dell’utente come per la creazione del documento transitorio.

  4. In AgreementInfo, aggiungi il codice seguente e fai clic su Try it Out:

    { 
  "fileInfos": [ 
    {    "transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*" 
    } 
  ], 
  "name": "Test", 
  "participantSetsInfo": [ 
    { 
      "memberInfos": [ 
        { 
          "email": "signer@email.com" 
        } 
      ], 
      "order": 1, 
      "role": "SIGNER" 
    } 
  ], 
  "signatureType": "ESIGN", 
  "state": "IN_PROCESS" 
}

     

    Viene ricevuta una risposta simille alla seguente con agreementId:

    { 
  
  "id": "CBJCHBCAABAAUlen3l_fzlj1Kbn_wGZAhYcIgN0J7Qtq" 
  
}

  1. Accedi ad Acrobat Sign.

  2. Vai a Acrobat Sign API > API Information e fai clic su Documentazione del metodo API REST.

    Interfaccia utente Webhook

  3. POST /transientDocuments, carica un file e crea un ID documento transitorio.

  4. Copia l’ID del documento transitorio e utilizzalo nel metodo POST /agreements. Indica la seguente richiesta JSON nella casella:

    { 
    "documentCreationInfo": { 
        "mergeFieldInfo": null, 
        "recipientSetInfos": [{ 
                "signingOrder": null, 
                "recipientSetRole": "SIGNER", 
                "recipientSetMemberInfos": [{ 
                    "securityOptions": null, 
                    "email": "test1@gmail.com" 
                }], 
                "privateMessage": "Hello 1", 
                "securityOptions": null 
            }, 
            { 
                "signingOrder": null, 
                "recipientSetRole": "SIGNER", 
                "recipientSetMemberInfos": [{ 
                    "securityOptions": null, 
                    "email": "test2@gmail.com" 
                }], 
                "privateMessage": "Hello 2", 
                "securityOptions": null 
            } 
        ], 
        "signatureType": "ESIGN", 
        "callbackInfo": null, 
        "message": "Please review and sign this document.", 
        "locale": "en_US", 
        "vaultingInfo": null, 
        "securityOptions": null, 
        "reminderFrequency": null, 
        "ccs": null, 
        "postSignOptions": null, 
        "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", 
        "daysUntilSigningDeadline": null, 
        "formFieldLayerTemplates": [], 
        "name": "Acrobat Sign Agreement", 
        "formFields": null, 
        "fileInfos": [{ 
            "libraryDocumentName": null, 
            "transientDocumentId": "XXXXXXXXXXXX", 
            "documentURL": null, 
            "libraryDocumentId": null 
        }] 
    } 
}

  5. Per eseguire la richiesta JSON, fai clic sul pulsante Try it Out.

    Interfaccia utente Webhook

    Il codice JSON corretto restituisce la risposta con l’ID dell’accordo.

    Interfaccia utente Webhook

Di seguito sono riportati i parametri che puoi passare nel simbolo per impostare la password di apertura:

 

{

    "documentCreationInfo":

    [{

        "signatureType": "ESIGN",

               "recipientSetInfos": [{

            "recipientSetMemberInfos": [{                      

                "email": "abc@xyz.com"                  

            }],

                   

            "recipientSetRole": "SIGNER"                         

        }],

               "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED",

                   "fileInfos": [           {               

            "libraryDocumentId": "3AAABLblqZhBsm_vH7TVzU3hRdbtWuvzfTKDvBzaKZTiehjO2eGTk5Rlu02K-0BYn8HBJVFTWOmT_BQlrofPBlrCdjiJ_JI-V"        

        }       ],

               "name": "Password di apertura per visualizzare il documento",

               "securityOptions": {        

            "openPassword": "1234",

                     "protectOpen": true   

        }  

    }]

}

 

Per creare un accordo tramite API con stato “AUTHORING”, effettua le seguenti operazioni:

Accedi a POST /agreements e crea un token di accesso con gli ambiti richiesti.

Utilizza il codice di richiesta nel modo seguente:

 

{

  "fileInfos": [

    {

      "transientDocumentId": "*********************"

    }

  ],

  "name": "A1",

  "participantSetsInfo": [

    {

      "memberInfos": [

        {

          "email": "abc@xyz.com"

        }

      ],

      "order": 1,

      "role": "SIGNER"

    }

  ],

  "signatureType": "ESIGN",

  "state": "AUTHORING"

}

 

La versione 6 dispone di un set di API per la creazione di un accordo. Nella versione 5, i formFields vengono utilizzati direttamente nell’API POST /agreements. Tuttavia, nella versione 6 gli utenti possono creare un accordo nello stato AUTHORING (state = AUTHORING) tramite POST v6 /agreements e utilizzare PUT /agreements/ID/formFields in qualsiasi un secondo tempo per aggiungere dei campi modulo ai documenti dell’accordo.

Di seguito sono riportati i passaggi da eseguire:

  1. Accedi alla documentazione delle API REST v6 e seleziona il metodo POST /agreements.

  2. Utilizza il seguente codice di richiesta:

    { 
  "fileInfos": [ 
    { 
      "transientDocumentId": "***************************" 
    } 
  ], 
  "name": "test", 
  "participantSetsInfo": [ 
    { 
      "memberInfos": [ 
        { 
          "email": "abc@gmail.com" 
        } 
      ], 
      "order": 1, 
      "role": "SIGNER" 
    } 
  ], 
  "signatureType": "ESIGN", 
  "state": "AUTHORING" 
}

  3. Utilizza il metodo PUT /agreements/{agreementId}/formFields con la seguente richiesta di esempio:

    { 
  "fields": [ 
    { 
     "locations": [ 
          { 
            "height": 36, 
            "left": 75, 
            "pageNumber": "1", 
            "top": 200, 
            "width": 150 
          } 
        ], 
        "contentType": "SIGNATURE_BLOCK", 
        "name": "sigBlock1", 
        "inputType": "SIGNATURE", 
        "recipientIndex":1 
       } 
]}

     

    Una volta completata la richiesta, l’accordo viene inviato al destinatario indicato.

  1. Accedi ad Acrobat Sign.

  2. Vai a acrobat Sign API>API Information e fai clic su REST API Method Documentation.

    Interfaccia utente Webhook

  3. POST /transientDocuments, carica un file e crea un ID documento transitorio.

  4. Copia l’ID del documento transitorio e utilizzalo nel metodo POST /agreements. Indica la seguente richiesta JSON nella casella:

    { 
    "documentCreationInfo": { 
        "recipientSetInfos": [{ 
                "recipientSetRole": "SIGNER", 
                "recipientSetMemberInfos": [{ 
                    "email": "test1@gmail.com" 
                }], 
                "privateMessage": "Hello 1" 
            }, 
            { 
                "recipientSetRole": "SIGNER", 
                "recipientSetMemberInfos": [{ 
                    "email": "test2@gmail.com" 
                }], 
                "privateMessage": "Hello 2" 
            } 
        ], 
        "signatureType": "ESIGN", 
        "message": "Rivedi e firma questo documento.", 
        "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", 
        "name": "Demo1", 
        "fileInfos": [{ 
            "transientDocumentId": "XXXXXXXXXX" 
        }], 
        "formFields": [{ 
                "hidden": "1", 
                "defaultValue": "test1@gmail.com", 
                "name": "Signer Email (Applicant-1)", 
                "inputType": "TEXT_FIELD", 
                "readOnly": true, 
                "locations": { 
                    "pageNumber": 1, 
                    "top": 100, 
                    "left": 100, 
                    "width": 100, 
                    "height": 30 
                }, 
  
                "contentType": "SIGNER_EMAIL" 
            }, 
            { 
                "name": "Signature (Applicant-2)", 
                "inputType": "SIGNATURE", 
                "locations": { 
                    "pageNumber": 1, 
                    "top": 520, 
                    "left": 162, 
                    "width": 280, 
                    "height": 30 
                }, 
                "contentType": "SIGNATURE", 
                "required": 1, 
                "recipientIndex": 1 
            }, 
            { 
                "name": "Signature (Applicant-3)", 
                "inputType": "SIGNATURE", 
                "locations": { 
                    "pageNumber": 2, 
                    "top": 312, 
                    "left": 154, 
                    "width": 280, 
                    "height": 30 
                }, 
                "contentType": "SIGNATURE", 
                "required": 1, 
                "recipientIndex": 1 
            }, 
            { 
                "defaultValue": "017/09/2018", 
                "displayFormatType": "DATE", 
                "name": "Signature Date (Applicant-4)", 
                "format": "DATE_DD_MM_YYYY", 
                "inputType": "TEXT_FIELD", 
                "readOnly": true, 
                "locations": { 
                    "pageNumber": 2, 
                    "top": 260, 
                    "left": 90, 
                    "width": 80, 
                    "height": 30 
                }, 
                "contentType": "DATA", 
                "required": 1, 
                "recipientIndex": 1 
            }, 
            { 
                "name": "Signature (Applicant-5)", 
                "inputType": "SIGNATURE", 
                "locations": { 
                    "pageNumber": 3, 
                    "top": 199, 
                    "left": 179, 
                    "width": 276, 
                    "height": 30 
                }, 
                "contentType ": "SIGNATURE", 
                "required": 1, 
                "recipientIndex": 1 
            }, 
            { 
                "contentType": "SIGNATURE_DATE", 
                "defaultValue": "06/07/2018", 
                "displayFormatType": "DATE", 
                "name": "Signature Date (Applicant-6)", 
                "format": "DATE_DD_MM_YYYY", 
                "inputType": "TEXT_FIELD", 
                "readOnly": true, 
                "locations": { 
                    "pageNumber": 3, 
                    "top": 188, 
                    "left": 488, 
                    "width": 76, 
                    "height": 25 
                }, 
                "required": 1, 
                "recipientIndex": 1 
            }, 
            { 
                "name": "Signature (Applicant-7)", 
                "inputType": "SIGNATURE", 
                "locations": { 
                    "pageNumber": 3, 
                    "top": 370, 
                    "left": 37, 
                    "width": 210, 
                    "height": 26 
                }, 
                "contentType ": "SIGNATURE", 
                "required": 1, 
                "recipientIndex": 2 
            }, 
            { 
                "contentType ": "SIGNATURE_DATE", 
                "defaultValue": "01/02/2018", 
                "name": "Signature Date (Applicant-8)", 
                "locations": { 
                    "pageNumber": 3, 
                    "top": 370, 
                    "left": 300, 
                    "width": 76, 
                    "height": 26 
                }, 
                "required": 1, 
                "recipientIndex": 2 
  
            } 
        ] 
    } 
}

  5. Per eseguire la richiesta JSON, fai clic sul pulsante Try it Out.

    Interfaccia utente Webhook

    Il codice JSON corretto restituisce la risposta con l’ID dell’accordo.

    Interfaccia utente Webhook

  1. Accedi ad Acrobat Sign.

  2. Vai ad Acrobat Sign API > Informazioni API e fai clic su Documentazione metodi API REST.

    Fnord.

  3. POST /transientDocuments, carica un file e crea un ID documento transitorio.

  4. Copia l’ID del documento transitorio e utilizzalo nel metodo POST /agreements. Indica la seguente richiesta JSON nella casella:

    { 
    "options": { 
        "noChrome": true, 
        "authoringRequested": true 
    }, 
    "documentCreationInfo": { 
        "recipientSetInfos": [{ 
                "recipientSetRole": "SIGNER", 
                "recipientSetMemberInfos": [{ 
                    "email": "test1@gmail.com" 
                }], 
                "privateMessage": "Hello 1" 
            }, 
            { 
                "recipientSetRole": "SIGNER", 
                "recipientSetMemberInfos": [{ 
                    "email": "test2@gmail.com" 
                }], 
                "privateMessage": "Hello 44" 
            } 
        ], 
        "signatureType": "ESIGN", 
        "message": "Please review and sign this document.", 
        "locale": "en_US", 
        "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", 
        "formFieldLayerTemplates": [], 
        "name": "Acrobat Sign Agreement", 
        "formFields": null, 
        "fileInfos": [{ 
            "libraryDocumentName": null, 
            "transientDocumentId": "XXXXXXXXXXXX" 
        }] 
    } 
}

  5. Per eseguire la richiesta JSON, fai clic sul pulsante Try it Out.

    Fnord.

    Il codice JSON corretto restituisce la risposta con l’ID dell’accordo.

    Fnord.

  6. Per aprire l’accordo in modalità di creazione, copia l’URL e incollalo nella barra degli indirizzi di un browser.

  7. Trascina i campi modulo nella posizione desiderata.

  8. Per inviare l’accordo da firmare, fai clic su Invia. 

Usa POST /agreements per creare un accordo. Viene inviato per la firma e l’ID dell’accordo viene restituito nella risposta al client. Di seguito è riportato il formato JSON per inviare un accordo mediante il metodo di autenticazione telefonica.

 

{

"documentCreationInfo": {

"mergeFieldInfo": null,

"recipientSetInfos": [{

"signingOrder": null,

"recipientSetRole": "SIGNER",

"recipientSetMemberInfos": [{

"securityOptions": null,

"email": "Signer@email.com"

}],

 

"privateMessage": null,

"securityOptions": [{

"authenticationMethod": "PHONE",

"phoneInfos": [{

"phone": "1111111111",

"countryCode": "+1"

}]

}]

}],

 

"signatureType": "ESIGN",

"callbackInfo": null,

"message": "Rivedi e firma questo documento.",

"locale": "en_US",

"vaultingInfo": null,

"securityOptions": null,

"reminderFrequency": null,

"ccs": null,

"postSignOptions": null,

"signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED",

"daysUntilSigningDeadline": null,

"formFieldLayerTemplates": [],

"name": "Acrobat Sign Agreement-Phone authentication testing",

"formFields": null,

"fileInfos": [{

"libraryDocumentName": null,

"transientDocumentId": "3AAABLYourTransactionID",

"documentURL": null,

"libraryDocumentId": null

}]

},

 

"options": {

"autoLoginUser": true,

"authoringRequested": false,

"noChrome": true,

"sendThroughWeb": null,

"sendThroughWebOptions": null,

"locale": "en_US"

}

}

 

È possibile unire i dati direttamente nei campi modulo utilizzando i seguenti metodi:

  • Mediante un modello libreria:

    Se nel parametro FileInfo utilizzi un ID di modello libreria, assicurati di specificare il nome esatto del campo e i relativi dati associati nella sezione seguente:

 

"mergeFieldInfo": [

     {

       "defaultValue": "",

       "fieldName": ""

     }

   ],

 

  • Mediante tag di testo in un documento caricato come documento transitorio:

    Se carichi un documento a cui sono stati aggiunti tag di testo come documento transitorio, assicurati di fornire il nome esatto del campo e i relativi dati associati nella sezione seguente: 

 

"mergeFieldInfo": [

     {

       "defaultValue": "",

       "fieldName": ""

     }

   ],

 

Come inviare un accordo mediante API con valori precompilati per i campi modulo specifici (campi unione)?

Prerequisito di questa chiamata è completare prima il passaggio "Caricamento temporaneo" e ottenere un "transientDocumentId" (utilizzando: secure.na1.echosign.com/public/docs/restapi/v5#!/transientDocuments/createTransientDocument) da usare qui.

  • Questa chiamata include la sezione “mergeFieldInfo” in cui vengono forniti i valori predefiniti di campi modulo specifici.
  • In tal modo nella chiamata API vengono pre-compilati i dati provenienti da un altro sistema.
  • Tali campi nell’accordo possono essere modificabili o di sola lettura.

 

Prerequisiti:

  1. ID documento transitorio
  2. Nomi dei campi e relativi valori

 

Esempio di chiamata di richiesta:

 

Richiesta:

POST /api/rest/v5/agreements HTTP/1.1

host: api.na1.echosign.com (oppure puoi specificare il nome del tuo shard, che puoi trovare utilizzando la chiamata getbaseURis: https://secure.na1.echosign.com/public/docs/restapi/v5#!/base_uris/getBaseUris

Token di accesso: 2AAABLblqZhA_D1mluNKQP7py5vXtt-1UHl9NR25e_C3LnKTUH14IblbrXODbXGRozyr7ChBkJNM*

x-user-email: sender@yourdomain.com

Content-Type: application/json

Cache-Control: no-cache

 

{

   "documentCreationInfo": {

       "signatureType": "ESIGN",

       "recipientSetInfos": [

           {

               "recipientSetMemberInfos": [

                   {

                       "email": “signerEmail@domain.com"

                   }

               ],

               "recipientSetRole": "SIGNER"

           }

        ],

      

       "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED",

       "message": "Ti i invitiamo a firmare questo documento!",

       "fileInfos": [

           {

               "transientDocumentId": "3AAABLblqZhD1uP3ZnkJximC0JV1S677PR5xmybSJ-SJn6OtEy2tVqFyMN4xUAbhKTSkLw2Zb6HEF4zAGsrUd2ycoB8fFHQJhrci0O6267VztmIL4nCicSqvAjO7HckATHAsovVmuYwI9_FDDgHg0ogyti62L13HQFZIQRe9iyQMvvzbmksM7ODNK_HEepEKRCeJTtis9FOlz6uRCcIMNlbX_2GU8utWT"

           }

       ],

       "name": "MSA Edited”,

        "mergeFieldInfo": [

            {

                "fieldName": "AccountName",

                "defaultValue": "Sam's Garage"

            },

            {

                "fieldName": "AccountNumber",

                "defaultValue": "8756999"

            },

            {

                "fieldName": "Zip",

                "defaultValue": "94501"

            },

            {

                "fieldName": "City",

                "defaultValue": "CityVille"

            },

            {

                "fieldName": "State",

                "defaultValue": "CA"

            },

            {

                "fieldName": "Street",

                "defaultValue": "123 Some Road"

            },

            {

                "fieldName": "Title1",

                "defaultValue": "COO"

            },

            {

                "fieldName": "Description",

                "defaultValue": "Some new description here"

            }

        ]

   }

 

}

 

La risposta a questa chiamata è l’ID “agreementId” che dovrai memorizzare nel sistema per le chiamate successive (signingUrl, status, formData, ecc.).

 

Risposta:

{

  "agreementId": "3AAABLblqZhCf_7xDcrOgKFwAabp1S-OFfvUdHf2wJsSMwlB95_x_WdUeab67jOkJi1IJzWuSJ0zdNNKugS1blZB4LT5vNVyJ"

}

 

Durante l’esecuzione del metodo “POST /megaSigns/{megaSignId}/views”, viene visualizzato un errore di tipo “La vista richiesta non è disponibile per la risorsa nel suo stato corrente”.

Questo errore viene presentato se il valore del nome del parametro fornito non è valido nel codice di richiesta seguente:

{
  "name": " "
}

Ad esempio, se lo stato dell’accordo MegaSign è già “IN_PROCESS”, il valore “AUTHORING” restituirà questo errore. Verifica che il valore fornito sia conforme allo stato corrente dell’accordo.

Durante l’esecuzione del metodo “put /megaSigns/{megaSignId}/state”, viene presentato un errore di tipo “Nessun valore fornito per le informazioni di annullamento MegaSign”.

Questo errore si verifica se manca il codice di richiesta del parametro:

 "megaSignCancellationInfo": {
    "comment": "",
    "notifyOthers": false
  }

Anziché utilizzare lo “Schema minimo”, fai clic su “Modello schema completo” e fornisci il codice di richiesta completo per eseguire la chiamata API. 

Per modificare lo stato dell’accordo MegaSign, utilizza PUT /megaSigns/{megaSignId}/state ed effettua le seguenti operazioni:

  1. Passa alla documentazione API REST per v6 e seleziona il metodo 
    PUT /megaSigns/{megaSignId}/state.
  2. Specifica il valore di Authorization, nonché If-Match e megasignID.
    • Per recuperare il codice megasignID, utilizza GET /megaSigns.
    • Per recuperare il valore If-Match, utilizza GET /megaSigns/{megaSignId} e individua “Etag” nell’intestazione.
  3. {
      "state": "CANCELED",
      "megaSignCancellationInfo": {
       "comment": "cancel",
       "notifyOthers": false
      }
    } 

Per registrare correttamente un webhook, il suo URL risponde a questa richiesta di verifica con un codice di risposta 2XX; inoltre, può restituire lo stesso valore di ID client in uno dei due modi seguenti:

  1. In un’intestazione di risposta X-AdobeSign-ClientId. Si tratta della stessa intestazione trasmessa nella richiesta, che viene riecheggiata nella risposta.
  2. Nel corpo della risposta JSON con la chiave X-AdobeSign-ClientId. Il suo valore corrisponde all’ID client inviato nella richiesta.

Acrobat Sign riceve la risposta 2xx con X-AdobeSign-ClientId. L'utente può verificare se è configurato correttamente nel webhook o meno.

L’URL del webhook non risponde in base al comportamento previsto. Per ogni notifica Post che Acrobat Sign invia, l'URL risponde con il codice di stato 2XX e restituisce l'ID client inviato nelle intestazioni della richiesta (X-AdobeSign-ClientId) nelle intestazioni della risposta. 

Per informazioni complete, consulta il seguente collegamento:
https://developer.adobe.com/acrobat-sign/docs/overview/developer_guide/#!adobedocs/adobe-sign/master/webhooks/webhook_events.md

Quando l'URL non riesce a rispettare questo protocollo, Acrobat Sign considera che non ha riconosciuto la richiesta e tenta di riprogrammare secondo il criterio di affidabilità.

Se il webhook non risponde e viene superato il tempo o l’intervallo massimo di tentativi, il webhook viene disabilitato.

Questo prodotto è concesso in licenza in base alla licenza di Attribuzione-Non commerciale-Condividi allo stesso modo 3.0 Unported di Creative Commons  I post su Twitter™ e Facebook non sono coperti dai termini di Creative Co


Gestire/Ottenere informazioni sugli accordi

Per modificare un documento già inviato per la firma, utilizza il metodo PUT /agreements/{agreementId} con cui puoi aggiornare un accordo esistente. Fornisci l’ID transitorio e l’ID accordo nel seguente codice di richiesta:

 

{

  "documentUpdateInfo": {

    "fileInfos": [

      {

        "agreementDocumentId": "",

        "transientDocumentId": ""

      }

    ]

  }

}

 

Di seguito sono riportate le istruzioni per cambiare lo stato da “AUTHORING” a “IN_PROCESS” utilizzando PUT /agreements/{agreementId}/state:

  1. Ottieni l’ID accordo recuperato utilizzando il metodo POST /agreements.

  2. Utilizza GET /agreements/{agreementId} per recuperare l’ultimo ETag.

  3. Passa a PUT /agreements/{agreementId}/state e fornisci le seguenti informazioni: "state": "IN_PROCESS"

No.

Non esiste alcun metodo nell’API REST corrente per caricare una copia firmata.

Il mittente deve caricare la copia firmata dalla pagina Gestisci.

DELETE /agreements/ID utilizzato per consentire di nascondere un accordo dalla pagina di gestione.

Adobe ha una nuova API PUT /agreements/ID/me/visibility per controllare la visibilità di un accordo (in GET /agreements). Oltre alla funzionalità fornita dal metodo DELETE /agreements/ID, il nuovo endpoint di visibilità consente anche all’utente di annullare l’operazione “hide”, per rendere nuovamente visibile l’accordo. 

Puoi anche seguire i passaggi dettagliati riportati di seguito:

  1. Passa al metodo GET /agreements e recupera l’ID dell’accordo.
  2. Fai clic su PUT /agreements/{agreementId}/me/visibility e fornisci la seguente richiesta di esempio:
    {
      “visibility”: “HIDE”
    }
    L’ID dell’accordo è nascosto solo da GET /libraryDocuments, ma è ancora visibile nella scheda Gestisci.
Nota:

La funzione API Retention (conservazione) non è attivata per impostazione predefinita.

Per abilitare l’operazione DELETE /agreements, chiedi al tuo Success Manager che l’opzione API Retention sia attivata per l’account.

Per ulteriori informazioni su come abilitare le funzionalità di conservazione per il tuo account, consulta Acrobat  Sign - Document Retention.

  1. Accedi come amministratore di Acrobat Sign e vai a:  https://secure.adobesign.com/public/docs/restapi/v6

    • Fai clic su agreements ed espandi il metodo GET /agreements.
    • Fai clic sul pulsante OAUTH ACCESS-TOKEN. 
    • Abilita l’ambito agreement_read:self.
    • Fai clic sul pulsante Autorizza
      • Se richiesto, fai clic su Consenti accesso.
    • Fai clic su Provalo! .
    Metodo GET /agreements

  3. Viene generata la risposta.

    Il codice agreementID si trova nel corpo della risposta:

    Risposta di GET /agreements

  4. DELETE /agreements/{agreementId}/documents: elimina tutti i documenti correlati a un accordo. L’accordo stesso resta visibile nella pagina Gestisci.

    • Seleziona l’operazione DELETE /agreements da eseguire.
    • Fai clic sul pulsante OAUTH ACCESS-TOKEN e crea un token di accesso con ambito agreement_retention.
    • Fornisci il codice agreementId dell’accordo da eliminare.
    • Una volta eliminato l’accordo, il corpo della risposta contiene “nessun contenuto”.

Se ricevi la risposta seguente, significa che l’operazione DELETE /agreements non è abilitata:

 "code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",

  "message": "L’operazione richiede l’attivazione di alcune impostazioni account. Contatta il team di Acrobat Sign per abilitare le impostazioni."

Come scaricare il documento firmato insieme al rapporto di audit e al documento di supporto tramite l'API REST di Acrobat Sign anziché effettuare una chiamata separata per scaricare il rapporto di audit utilizzando il seguente metodo.

GET /agreements/{agreementId}/auditTrail

  1. Passa a: https://secure.na1.adobesign.com/public/docs/restapi/v5.

  2. Fai clic su GET /agreements/{agreementId}/combinedDocument.

  3. Fai clic sul pulsante OAuth Access-token.

  4. Il token di accesso viene generato automaticamente una volta accettata l’autorizzazione.

  5. Fornisci l’ID agreementId.

  6. In attachSupportingDocuments, seleziona true dal menu a discesa.

  7. In attachAuditReport, seleziona true dal menu a discesa.

  8. Fai clic sul pulsante Try it Out. 

    Ottenere i documenti combinati

    Viene scaricato un PDF combinato con l’accordo Firmato, il documento di supporto e il report di audit.

Per scaricare più documenti in blocco, è disponibile solo lo strumento di esportazione dei documenti; con l’API è possibile scaricare solo un documento alla volta. Di seguito è riportato il metodo API:

https://secure.na1.adobesign.com/public/docs/restapi/v5#!/agreements/getCombinedDocument


Modelli libreria e moduli Web

  1. Accedi ad Acrobat Sign come amministratore e vai a: https://secure.na1.adobesign.com/public/docs/restapi/v6

    • Fai clic su libraryDocuments ed espandi il metodo GET /libraryDocuments.
    • Fai clic sul pulsante OAUTH ACCESS-TOKEN. 
    • Abilita l’ambito library_read:self.
    • Fai clic sul pulsante Autorizza
      • Se richiesto, fai clic su Consenti accesso.
    • Fai clic su Provalo! .
    Metodo GET LibraryDocument

  3. Viene generata la risposta.

    Il codice libraryDocumentId si trova nel corpo della risposta:

    Risposta di GET LibraryDocument

Adobe ha un nuovo metodo API PUT/libraryDocuments/ID/me/visibility che consente di controllare la visibilità di un accordo (in GET /agreements). Oltre alla funzionalità fornita da DELETE /agreements/ID, il nuovo endpoint di Visibilità consente anche a un Utente di annullare l'operazione 'comprimere', ovvero rendere nuovamente visibile l'accordo.

Puoi seguire i passaggi dettagliati di seguito:

  1. Passa al metodo GET /libraryDocuments e recupera l’ID dell’accordo.
  2. Fai clic su PUT /libraryDocuments/{libraryDocumentId}/me/visibility e fornisci la seguente richiesta di esempio:
    {
      "visibility": "HIDE"
    }
    L’ID della libreria è nascosto solo da GET /libraryDocuments, ma è ancora visibile nella scheda Gestisci.
Nota:
  • Invia una richiesta al team di supporto per richiedere che venga abilitato l’ambito per l’eliminazione della libreria.
  • L’API elimina il documento libreria. Tuttavia, gli accordi creati con il documento libreria restano intatti.


Generazione di un codice libraryDocumentID

  1. Passa a https://secure.echosign.com/public/docs/restapi/v5.

  2. Fai clic su libraryDocuments.

  3. Fai clic sul pulsante OAuth Access-Token. 

    Autorizza l’accesso: token per se stesso, gruppo o account.

  4. Seleziona libraryTemplateType - Document o Form_field_layer.

  5. Fai clic su Try it Out per provarlo.

    Puoi ricevere una risposta come quella seguente per tutti i tuoi modelli. Copia l’ID libraryDocumentId per il modello libreria da eliminare.

    { 
  "libraryDocumentList": [ 
    { 
      "name": "testing fields", 
      "modifiedDate": "2017-08-04T01:06:05-07:00", 
      "scope": "PERSONAL", 
      "libraryDocumentId": "3AAABLblqZhAK53Dvzq88Q1Ov0TEvMAySDPpIVjF1PWgUpy0H1uYggt4iwGiRSZYlWfl9ms_AcmgZ_uZMPPN2hNT9izwaspHc", 
      "libraryTemplateTypes": [ 
        "DOCUMENT" 
      ] 
    },


Eliminazione dei modelli libreria

  1. Copia l’ID libraryDocumentID dal corpo della risposta.

  2. Passa a DELETE libraryDocuments.

  3. Fai clic sul pulsante OAuth Access-token. Autorizza l’accesso: token per se stesso, gruppo o account.

  4. Incolla l’ID libraryDocumentId nel campo Value.

  5. Fai clic su Try it Out. 
    Il modello viene eliminato.

    Viene visualizzato il seguente codice di errore: 204

Nota:

È possibile aggiornare solo i moduli web che si trovano nello stato Bozza.

  1. Crea il widget utilizzando il metodo POST /widgets.

  2. Ottieni l’ID del widget da GET /widgets.

  3. Una volta creato utilizzando il metodo GET /widgets/{widgetId}, recupera l’Etag dall’intestazione della risposta.

    Foo

  4. In PUT /widgets/{widgetId}, utilizza il valore Etag da GET /widgets/{widgetId}. Per il parametro If-Match, immetti widgetId e widgetInfo.

    Foo 

    { 
  "fileInfos": [ 
    { 
      "transientDocumentId": "******" 
    } 
  ], 
  "name": "Widht_Name", 
  "status": "DRAFT", 
  "widgetParticipantSetInfo": { 
    "memberInfos": [ 
      { 
        "email": "" 
      } 
    ], 
    "role": "SIGNER" 
  } 
}


Esempi di utilizzo

  1. Effettua una chiamata GET /agreements con il valore x-api-user corretto.

  2. Nel corpo della risposta, individua l’accordo inviato per la firma di cui desideri trovare l’URL di firma e prendi nota dell’ID dell’accordo.

  3. Effettua una chiamata GET /agreements/{agreementId}/signingUrls utilizzando l’ID dell’accordo ricevuto dalla chiamata GET /agreements.

     

    Risultato

    L’output restituisce l’indirizzo e-mail dei firmatari e l’URL per la firma elettronica.

    Metodo GET /agreements

Adobe, Inc.

Ottieni supporto in modo più facile e veloce

Nuovo utente?

Collegamenti rapidi

Visualizza tutti i tuoi piani Gestione dei piani
Visualizza collegamenti rapidi
Nascondi collegamenti rapidi

Note legali    |    Informativa sulla privacy online