DocuSign
Utilizza il connettore DocuSign per eseguire operazioni di lettura su DocuSign.
Prima di iniziare
Prima di utilizzare il connettore DocuSign, svolgi le seguenti attività:
- Nel tuo progetto Google Cloud:
- Assicurati che la connettività di rete sia configurata. Per informazioni sui pattern di rete, consulta Connettività di rete.
- 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 un utente "non umano" che deve eseguire l'autenticazione ed essere autorizzato ad accedere ai dati nelle API 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 scoprire come attivare i servizi, consulta Abilitazione 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:
- Nella console Cloud, vai alla pagina Connettori di integrazione > Connessioni, quindi seleziona o crea un progetto Google Cloud.
- Fai clic su + CREA NUOVO per aprire la pagina Crea connessione.
- Nella sezione Località, scegli la località della connessione.
- Regione: seleziona una località dall'elenco a discesa.
Per l'elenco di tutte le regioni supportate, consulta Località.
- Fai clic su AVANTI.
- Regione: seleziona una località dall'elenco a discesa.
- Nella sezione Dettagli connessione, completa quanto segue:
- Connettore: seleziona DocuSign dall'elenco a discesa dei connettori disponibili.
- Versione del connettore: seleziona la versione del connettore dall'elenco a discesa delle versioni disponibili.
- 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 superare i 49 caratteri.
- (Facoltativo) Inserisci una Descrizione per l'istanza di connessione.
- Se vuoi, attiva Cloud Logging e poi seleziona un livello di log. Per impostazione predefinita, il livello di log è impostato su
Error
. - Account di servizio: seleziona un account di servizio con i ruoli richiesti.
- Se utilizzi un account sandbox DocuSign, puoi selezionare UseSandbox.
- (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. Per elaborare più transazioni per una connessione sono necessari più nodi e, al contrario, sono necessari meno nodi per elaborare meno transazioni. Per capire 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 maggiore disponibilità) e il numero massimo di nodi è impostato su 50.
- Se vuoi, fai clic su + AGGIUNGI ETIQUETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
- Fai clic su AVANTI.
-
Nella sezione Autenticazione, inserisci i dettagli di autenticazione.
- Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.
La connessione DocuSign supporta i seguenti tipi di autenticazione:
- OAUTH 2.0 - Authorization Code
- OAuth 2.0 - JWT Bearer
- Fai clic su AVANTI.
Per capire come configurare questi tipi di autenticazione, consulta Configurare l'autenticazione.
- Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.
- Rivedi: controlla i dettagli di connessione e autenticazione.
- Fai clic su Crea.
Configura autenticazione
Inserisci i dettagli in base all'autenticazione che vuoi utilizzare.
- OAUTH 2.0 - Authorization Code
- ID client: l'ID client utilizzato per richiedere i token di accesso.
- Ampiezze: un elenco separato da virgole degli ambiti desiderati.
- Client secret: il secret di Secret Manager contenente il client secret per l'app collegata che hai creato.
-
OAuth 2.0 - JWT Bearer
- Consumer Key dell'app connessa:la consumer key 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 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 | SERVICE_ACCOUNT_NAME@developer.gserviceaccount.com |
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 | SERVICE_ACCOUNT_NAME@developer.gserviceaccount.com |
Autenticazione | OAuth 2.0 - JWT Bearer |
Chiave utente dell'app collegata | 67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79 |
Nome utente | USER_NAME |
Chiave privata | PRIVATE_KEY |
Versione secret | 1 |
Entità, operazioni e azioni
Tutti i connettori di integrazione forniscono un livello di astrazione per gli oggetti dell'applicazione collegata. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione viene mostrata come entità, operazioni e azioni.
- Entità : un'entità può essere considerata un oggetto o una raccolta di proprietà nell'applicazione o nel servizio collegato. La definizione di un'entità varia da un connettore all'altro. Ad esempio, in un connettore di database le tabelle sono le entità, in un connettore di file server le cartelle sono le entità e in un connettore di 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:
La selezione di un'entità dall'elenco disponibile genera un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta le operazioni sulle entità dell'attività Connettori. Tuttavia, se un connettore non supporta nessuna delle operazioni sulle entità, queste operazioni non supportate non sono elencate nell'elenco
Operations
. - Azione : un'azione è una funzione di prima classe resa disponibile all'integrazione tramite l'interfaccia del connettore. Un'azione ti consente di apportare modifiche a una o più entità e varia da un connettore all'altro. 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.
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.
Esempi di operazioni sulle entità
Questa sezione mostra come eseguire alcune delle operazioni sulle entità in questo connettore.
Il valore di un ID entità deve essere passato direttamente, ad esempio 16ab549b-95d7-47cb-b557-c2476ef62d9d
. L'ID 16ab549b-95d7-47cb-b557-c2476ef62d9d
è il valore della chiave primaria univoca che deve essere passato.
Esempio: operazione LIST per l'entità "Account"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Account dall'elenco
Entity
. - Seleziona l'operazione
LIST
e poi fai clic su Fine. - Nella sezione Input attività dell'attività Connettori, puoi impostare filterClause in base alle tue esigenze.
Esempio: operazione LIST per l'entità "Documenti"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Documenti dall'elenco
Entity
. - Seleziona l'operazione
LIST
e poi fai clic su Fine. - Nella sezione Input attività dell'attività Connettori, puoi impostare filterClause in base alle tue esigenze.
Esempio: operazione LIST per l'entità "Envelopes"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Buste dall'elenco
Entity
. - Seleziona l'operazione
LIST
e poi fai clic su Fine. - Nella sezione Input attività dell'attività Connettori, puoi impostare filterClause in base alle tue esigenze.
Esempio: operazione LIST per l'entità "Cartelle"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Cartelle dall'elenco
Entity
. - Seleziona l'operazione
LIST
e poi fai clic su Fine. - Nella sezione Input attività dell'attività Connettori, puoi impostare filterClause in base alle tue esigenze.
Esempio: operazione LIST per l'entità "Gruppi"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Gruppi dall'elenco
Entity
. - Seleziona l'operazione
LIST
e poi fai clic su Fine. - Nella sezione Input attività dell'attività Connettori, puoi impostare filterClause in base alle tue esigenze.
Esempio: operazione LIST per l'entità "Utenti"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Utenti dall'elenco
Entity
. - Seleziona l'operazione
LIST
e poi fai clic su Fine. - 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à "Account"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Account dall'elenco
Entity
. - Seleziona l'operazione
GET
e poi fai clic su Fine. - 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"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Documenti dall'elenco
Entity
. - Seleziona l'operazione
LIST
e poi fai clic su Fine. - Per impostare la clausola di filtro, nella sezione Data Mapper di Mappatura dei dati, fai clic su Apri editor di mappatura dei dati e poi inserisci
Type='envelopes' AND Id='8e18be14-3254-4cbe-947d-f0d1cd62f5f8'
nel campo Valore di input e scegli la clausola di filtro come variabile locale.
Esempio: GET singolo record per l'entità "Envelopes"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Buste dall'elenco
Entity
. - Seleziona l'operazione
GET
e poi fai clic su Fine. - 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
8e18be14-3254-4cbe-947d-f0d1cd62f5f87
nel campo Valore di input e scegli EntityId come variabile locale.
Esempio: GET singolo record per l'entità "Cartelle"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Cartelle dall'elenco
Entity
. - Seleziona l'operazione
GET
e poi fai clic su Fine. - 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"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Gruppi dall'elenco
Entity
. - Seleziona l'operazione
GET
e poi fai clic su Fine. - 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"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Utenti dall'elenco
Entity
. - Seleziona l'operazione
GET
e poi fai clic su Fine. - 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
16ab549b-95d7-47cb-b557-c2476ef62d9d
nel campo 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 la risorsa Terraform 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 al proxy ProxyServer. |
proxy_password | SEGRETO | Falso | Una password da utilizzare per l'autenticazione al proxy ProxyServer. |
Utilizzare la connessione DocuSign in un'integrazione
Una volta creata, la connessione diventa disponibile sia nell'Apigee Integration sia nell'Application Integration. Puoi utilizzare 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 informazioni su come creare e utilizzare l'attività Connettori in Application Integration, consulta Attività Connettori.
Ricevere assistenza dalla community Google Cloud
Puoi pubblicare le tue domande e discutere di questo connettore nella community Google Cloud ai forum di Cloud.Passaggi successivi
- Scopri come sospendere e riprendere una connessione.
- Scopri come monitorare l'utilizzo dei connettori.
- Scopri come visualizzare i log dei connettori.