DocuSign

Utilizza il connettore DocuSign per eseguire operazioni di lettura su DocuSign.

Prima di iniziare

Prima di utilizzare il connettore DocuSign, esegui le seguenti attività:

• Nel tuo progetto Google Cloud:
  • Concedi il ruolo IAM roles/connectors.admin all'utente che configura il connettore.
  • Concedi i seguenti ruoli IAM all'account di servizio che vuoi utilizzare per il connettore:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Un account di servizio è un tipo speciale di Account Google destinato a rappresentare una persona non umana utente che deve autenticarsi e avere l'autorizzazione ad accedere ai dati nelle API di Google. Se non hai un account di servizio, devi crearne uno. Per maggiori informazioni, consulta Creare un account di servizio.

  • Attiva i seguenti servizi:
    • secretmanager.googleapis.com (API Secret Manager)
    • connectors.googleapis.com (API Connectors)

    Per informazioni su come abilitare i servizi, vedi Attivazione dei servizi.

  Se questi servizi o autorizzazioni non sono stati attivati in precedenza per il tuo progetto, ti verrà chiesto di attivarli durante la configurazione del connettore.

Configura il connettore

Per configurare il connettore devi creare una connessione all'origine dati (sistema di backend). Una connessione è specifica per un'origine dati. Ciò significa che se hai molte origini dati, devi creare una connessione distinta per ciascuna. Per creare una connessione:

1. Nella console Cloud, vai a Connettori di integrazione > Pagina Connessioni e poi selezionare o creare un progetto Google Cloud.

   Vai alla pagina Connessioni

2. Fai clic su + CREA NUOVO per aprire la pagina Crea connessione.
3. Nella sezione Località, scegli la località della connessione.
   1. Regione: seleziona una località dall'elenco a discesa.

      Per l'elenco di tutte le regioni supportate, consulta Località.

   2. Fai clic su AVANTI.
4. Nella sezione Dettagli connessione, completa i seguenti passaggi:
   1. Connettore: seleziona DocuSign dall'elenco a discesa dei connettori disponibili.
   2. Versione del connettore: seleziona la versione del connettore dall'elenco a discesa delle versioni disponibili.
   3. Nel campo Nome connessione, inserisci un nome per l'istanza di connessione.

      I nomi delle connessioni devono soddisfare i seguenti criteri:

      • I nomi delle connessioni possono contenere lettere, numeri o trattini.
      • Le lettere devono essere minuscole.
      • I nomi delle connessioni devono iniziare con una lettera e terminare con una lettera o un numero.
      • I nomi delle connessioni non possono contenere più di 49 caratteri.
   4. (Facoltativo) Inserisci una Descrizione per l'istanza di connessione.
   5. Se vuoi, attiva Cloud Logging e poi seleziona un livello di log. Per impostazione predefinita, il livello di log è impostato su Error.
   6. Account di servizio: seleziona un account di servizio con i ruoli richiesti.
   7. Se utilizzi un account sandbox DocuSign, puoi selezionare Usa sandbox.
   8. (Facoltativo) Configura le impostazioni del nodo di connessione:
      • Numero minimo di nodi: inserisci il numero minimo di nodi di connessione.
      • Numero massimo di nodi: inserisci il numero massimo di nodi di connessione.

      Un nodo è un'unità (o una replica) di una connessione che elabora le transazioni. Sono necessari più nodi per elaborare più transazioni per una connessione e, al contrario, meno nodi per elaborare meno transazioni. Per comprendere in che modo i nodi influiscono sui prezzi dei connettori, consulta Prezzi per i nodi di connessione. Se non inserisci alcun valore, per impostazione predefinita il numero minimo di nodi è impostato su 2 (per una migliore disponibilità) e il numero massimo di nodi è impostato su 50.

   Nota: puoi personalizzare i valori dei nodi di connessione solo se sei un cliente con pagamento a consumo.
   9. Facoltativamente, fai clic su + AGGIUNGI ETICHETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
   10. Fai clic su AVANTI.
5. Nella sezione Autenticazione, inserisci i dettagli di autenticazione.
   1. Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.

      La connessione DocuSign supporta i seguenti tipi di autenticazione:

      • OAUTH 2.0 - Codice di autorizzazione
      • OAuth 2.0 - JWT Bearer

   Per capire come configurare questi tipi di autenticazione, consulta Configurare l'autenticazione.

   2. Fai clic su AVANTI.
6. Verifica: controlla i dettagli della connessione e dell'autenticazione.
7. Fai clic su Crea.

Configura autenticazione

Inserisci i dettagli in base all'autenticazione che vuoi utilizzare.

• OAUTH 2.0 - Codice di autorizzazione
  • ID client: l'ID client utilizzato per richiedere i token di accesso.
  • Ambiti: un elenco separato da virgole degli ambiti desiderati.
  • Client Secret: secret di Secret Manager contenente il client secret per l'app connessa che hai creato.
• OAuth 2.0 - JWT Bearer
  • Chiave utente app connessa:la chiave utente fornita per l'app connessa che hai creato.
  • Nome utente: il nome utente associato all'app collegata che hai creato.
  • Chiave privata: il segreto Secret Manager contenente i contenuti del file della chiave privata. La chiave privata deve corrispondere alla chiave pubblica/al certificato fornito a Connector.

Esempi di configurazione delle connessioni

Questa sezione elenca i valori di esempio per i vari campi che configuri durante la creazione della connessione.

OAUTH 2.0 - Tipo di connessione del codice di autorizzazione

Nome campo	Dettagli
Località	us-central1
Connettore	DocuSign
Versione del connettore	1
Nome collegamento	gcp-docusign-new-auth
Abilita Cloud Logging	No
UseSandbox	Sì
Account di servizio	[e-mail]
Autenticazione	OAuth 2.0 - Codice di autorizzazione
ID client	67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
Ambiti	firma
Client secret	CLIENT_SECRET
Versione secret	1

OAuth 2.0 - Tipo di connessione JWT Bearer

Nome campo	Dettagli
Località	us-central1
Connettore	DocuSign
Versione del connettore	1
Nome collegamento	gcp-docusign-token
Abilita Cloud Logging	No
UseSandbox	Sì
Account di servizio	[e-mail]
Autenticazione	OAuth 2.0 - JWT Bearer
Chiave consumer app connessa	67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
Nome utente	USER_NAME
Chiave privata	PRIVATE_KEY
Versione secret	1

Entità, operazioni e azioni

Tutti gli Integration Connectors forniscono un livello di astrazione per gli oggetti dell'applicazione collegata. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione ti viene esposta sotto forma di entità, operazioni e azioni.

Nota: puoi visualizzare le entità, le operazioni e le azioni di un connettore nell'attività Connettori.

• Entità: un'entità può essere considerata un oggetto o un insieme di proprietà nel un'applicazione o un servizio connesso. La definizione di un'entità differisce da un connettore di rete. Ad esempio, in un connettore di database, le tabelle sono le entità, connettore file server, le cartelle sono le entità e, in un connettore del sistema di messaggistica, le code sono le entità.

  Tuttavia, è possibile che un connettore non supporti o non abbia entità, nel qual caso l'elenco Entities sarà vuoto.

• Operazione: un'operazione è l'attività che puoi eseguire su un'entità. Puoi eseguire su un'entità una delle seguenti operazioni:
  • Elenca
  • Scarica
  • Crea
  • Aggiorna
  • Elimina

  La selezione di un'entità dall'elenco disponibile genera un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta operazioni relative a entità. Tuttavia, se un connettore non supporta nessuna delle operazioni relative all'entità, come quelle non supportate operazioni non sono elencate nell'elenco Operations.

• Azione: un'azione è una funzione di prima classe resa disponibile per l'integrazione. attraverso l'interfaccia del connettore. Un'azione consente di apportare modifiche a una o più entità variano da connettore a connettore. In genere, un'azione avrà alcuni parametri di input e un parametro di output. Tuttavia, è possibile che un connettore non supporti alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Nota : a tutte le entità e alle azioni è associato uno schema. Ad esempio, uno schema delle azioni avrà i dettagli dei parametri, come ad esempio il parametro e il tipo di dati corrispondente. Lo schema (metadati) per entità e azioni viene recuperato dalla connessione in dal tuo backend. Se sono presenti aggiornamenti allo schema, questi non verranno applicati automaticamente alle connessioni esistenti. Dovrai aggiornare manualmente lo schema. Per aggiornare lo schema di una connessione, apri la pagina Dettagli connessione della connessione e poi fai clic su Aggiorna schema connessione.

Limitazioni del sistema

Il connettore DocuSign può elaborare 3 transazioni al secondo per nodo e limita le transazioni oltre questo limite. Per impostazione predefinita, Integration Connectors alloca 2 nodi (per una maggiore disponibilità) per una connessione.

Per informazioni sui limiti applicabili a Integration Connectors, vedi Limiti.

Nota: il numero di nodi Integration Connectors verrà scalato automaticamente in base al tuo utilizzo. Se invece vuoi prenotare capacità per volumi elevati senza in attesa della scalabilità automatica, puoi regolare il valore minimo del nodo per una connessione. Per elaborare più transazioni per una connessione, sono necessari più nodi. Al contrario, sono necessari meno nodi se una connessione elabora meno transazioni. Per configurare i valori del nodo:

• Se sei un cliente con pagamento a consumo, configura il valore minimo e massimo del nodo nella pagina di modifica della connessione.
• Se sei un cliente con abbonamento, contatta l'assistenza.

Il numero massimo di transazioni che un nodo può gestire dipende da vari fattori. Pertanto, prima di modificare il numero minimo di nodi per migliorare il throughput, ti consigliamo di verificare se i sistemi di backend sono configurati in modo ottimale per gestire il traffico richiesto.

Esempi di operazioni sulle entità

Questa sezione mostra come eseguire alcune delle operazioni relative alle entità in questo connettore.

Il valore di un ID entità deve essere trasmesso direttamente, ad esempio 16ab549b-95d7-47cb-b557-c2476ef62d9d. L'ID 16ab549b-95d7-47cb-b557-c2476ef62d9d è il valore univoco della chiave primaria che deve essere trasmesso.

Esempio: operazione LIST per l'entità "Account"

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Account dall'elenco Entity.
3. Seleziona l'operazione LIST e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, puoi impostare filterClause in base alle tue esigenze.

Esempio: operazione LIST per l'entità "Documenti"

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Documenti dall'elenco Entity.
3. Seleziona l'operazione LIST e poi fai clic su Fine.
4. Sezione Input attività dell'attività Connettori, puoi impostare filterClause in base alle tue esigenze.

Esempio: operazione LIST per l'entità "Envelopes"

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Buste dall'elenco Entity.
3. Seleziona l'operazione LIST e fai clic su Fine.
4. Sezione Input attività dell'attività Connettori, puoi impostare filterClause in base alle tue esigenze.

Esempio - Operazione LIST per l'entità "Cartelle"

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Cartelle dall'elenco Entity.
3. Seleziona l'operazione LIST e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, puoi impostare filterClause in base alle tue esigenze.

Esempio: operazione LIST per l'entità "Gruppi"

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Gruppi dall'elenco Entity.
3. Seleziona l'operazione LIST e fai clic su Fine.
4. Sezione Input attività dell'attività Connettori, puoi impostare filterClause in base alle tue esigenze.

Esempio: operazione LIST per l'entità "Utenti"

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Utenti dall'elenco Entity.
3. Seleziona l'operazione LIST e poi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, puoi impostare filterClause in base alle tue esigenze.

Puoi eseguire operazioni LIST anche sulle seguenti entità:

• UserInfo
• UserSignatures
• Aree di lavoro
• Destinatari
• AccountBrands
• AccountCustomFields
• EnvelopeTemplates
• EnvelopeAttachments
• EnvelopeConsumerDisclosures
• CloudStorageProviders
• CustomTabs
• Serrature
• GroupBrands
• GroupUsers
• PowerForms
• RecipientTabs
• SigningGroups
• SigningGroupUsers
• Modelli

Esempio: GET singolo record per l'entità "Accounts"

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Account dall'elenco Entity.
3. Seleziona l'operazione GET e fai clic su Fine.
4. Per impostare l'ID entità, nella sezione Data Mapper di Mappatura dei dati, fai clic su Apri editor di mappatura dei dati e poi inserisci 2.4578824E7 nel campo Valore di input e scegli EntityId come variabile locale.

Esempio: GET singolo record per l'entità "Documenti"

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Documenti dall'elenco Entity.
3. Seleziona l'operazione LIST e fai clic su Fine.
4. Per impostare la clausola del filtro, in Nella sezione Data Mapper di Data Mapping (Mappatura dati), fai clic su Apri editor mappatura dati e quindi inserisci Type='envelopes' AND Id='8e18be14-3254-4cbe-947d-f0d1cd62f5f8' nel campo Valore di input e scegli la clausola del filtro come variabile locale.

Esempio: GET singolo record per l'entità "Envelopes"

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Buste dall'elenco Entity.
3. Seleziona l'operazione GET e poi fai clic su Fine.
4. Per impostare l'ID entità, in Nella sezione Data Mapper di Data Mapping (Mappatura dati), fai clic su Apri editor mappatura dati e quindi inserisci 8e18be14-3254-4cbe-947d-f0d1cd62f5f87 nel campo Input Value (Valore di input) e scegli EntityId come variabile locale.

Esempio - GET singolo record per entità "Cartelle"

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Cartelle dall'elenco Entity.
3. Seleziona l'operazione GET e poi fai clic su Fine.
4. Per impostare l'ID entità, nella sezione Data Mapper di Mappatura dei dati, fai clic su Apri editor di mappatura dei dati e poi inserisci 05f76d13-a513-492b-8c58-176702768db0 nel campo Valore di input e scegli EntityId come variabile locale.

Esempio: GET singolo record per l'entità "Gruppi"

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Gruppi dall'elenco Entity.
3. Seleziona l'operazione GET e fai clic su Fine.
4. Per impostare l'ID entità, nella sezione Data Mapper di Mappatura dei dati, fai clic su Apri editor di mappatura dei dati e poi inserisci 1.4167231E7 nel campo Valore di input e scegli EntityId come variabile locale.

Esempio: GET singolo record per l'entità "Utenti"

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Utenti dall'elenco Entity.
3. Seleziona l'operazione GET e fai clic su Fine.
4. Per impostare l'ID entità, in Nella sezione Data Mapper di Data Mapping (Mappatura dati), fai clic su Apri editor mappatura dati e quindi inserisci 16ab549b-95d7-47cb-b557-c2476ef62d9d nel campo Input Value (Valore di input) e scegli EntityId come variabile locale.

Puoi eseguire operazioni GET anche sulle seguenti entità:

• UserInfo
• UserSignatures
• Aree di lavoro
• Destinatari
• AccountBrands
• AccountCustomFields
• EnvelopeTemplates
• EnvelopeAttachments
• EnvelopeConsumerDisclosures
• CloudStorageProviders
• CustomTabs
• Serrature
• GroupBrands
• GroupUsers
• RecipientTabs
• SigningGroups
• SigningGroupUsers
• Modelli

Utilizzare Terraform per creare connessioni

Puoi utilizzare il comando Terraform risorsa per creare una nuova connessione.

Per scoprire come applicare o rimuovere una configurazione Terraform, consulta: Comandi Terraform di base.

Per visualizzare un modello Terraform di esempio per la creazione di una connessione, consulta il modello di esempio.

Quando crei questa connessione utilizzando Terraform, devi impostare le seguenti variabili nel file di configurazione Terraform:

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
proxy_enabled	BOOLEANO	Falso	Seleziona questa casella di controllo per configurare un server proxy per la connessione.
proxy_auth_scheme	ENUM	Falso	Il tipo di autenticazione da utilizzare per l'autenticazione al proxy ProxyServer. I valori supportati sono: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Un nome utente da utilizzare per l'autenticazione sul proxy ProxyServer.
proxy_password	SECRET	Falso	Una password da utilizzare per l'autenticazione sul proxy ProxyServer.

Utilizzare la connessione DocuSign in un'integrazione

Una volta creata, la connessione diventa disponibile sia nell'integrazione Apigee sia nell'integrazione delle applicazioni. Puoi usare la connessione in un'integrazione tramite l'attività Connettori.

• Per informazioni su come creare e utilizzare l'attività Connectors in Apigee Integration, consulta Attività Connectors.
• Per capire come creare e utilizzare l'attività Connettori in Application Integration, vedi Attività connettori.

Ricevere assistenza dalla community Google Cloud

Puoi pubblicare le tue domande e discutere di questo connettore in Google Cloud nei forum di Cloud.

Passaggi successivi

• Scopri come sospendere e ripristinare una connessione.
• Scopri come monitorare l'utilizzo dei connettori.
• Scopri come visualizzare i log del connettore.