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:
- 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 al 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 di Google. Se non hai un account di servizio, devi crearne uno. Per maggiori informazioni, vedi Creare un service account.
- Attiva i seguenti servizi:
secretmanager.googleapis.com
(API Secret Manager)connectors.googleapis.com
(API Connectors)
Per capire come abilitare i servizi, consulta Abilitazione dei servizi.
Se questi servizi o queste autorizzazioni non sono stati attivati in precedenza per il tuo progetto, ti viene chiesto di attivarli durante la configurazione del connettore.
Configura il connettore
Una connessione è specifica per un'origine dati. Ciò significa che se hai molte origini dati, devi creare una connessione separata per ciascuna origine dati. Per creare una connessione:
- Nella console Cloud, vai alla pagina Integration Connectors > Connessioni e poi seleziona o crea un progetto Google Cloud.
- Fai clic su + CREA NUOVA per aprire la pagina Crea connessione.
- Nella sezione Località, scegli la località per la 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 contenere più di 49 caratteri.
- (Facoltativo) Inserisci una Descrizione per l'istanza di connessione.
- (Facoltativo) Abilita Cloud Logging,
quindi seleziona un livello di log. Per impostazione predefinita, il livello di log è impostato su
Error
. - Service Account: seleziona un account di servizio con i ruoli richiesti.
- (Facoltativo) Seleziona UseSandbox se utilizzi un account sandbox DocuSign.
- (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, viceversa, sono necessari meno nodi per elaborare meno transazioni. Per capire in che modo i nodi influiscono sui prezzi dei connettori, consulta la sezione Prezzi dei nodi di connessione. Se non inserisci alcun valore, per impostazione predefinita i nodi minimi sono impostati su 2 (per una migliore disponibilità) e i nodi massimi su 50.
- (Facoltativo) Fai clic su + AGGIUNGI ETICHETTA 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: rivedi i dettagli di connessione e autenticazione.
- Fai clic su Crea.
Configura l'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.
- 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 dell'app collegata:la chiave utente fornita per l'app collegata che hai creato.
- Nome utente: il nome utente associato all'app connessa che hai creato.
- Chiave privata: secret di 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 della connessione
Questa sezione elenca i valori di esempio per i vari campi che configuri durante la creazione della connessione.
OAUTH 2.0 - Authorization Code connection type
Nome campo | Dettagli |
---|---|
Località | us-central1 |
Connettore | DocuSign |
Versione del connettore | 1 |
Nome collegamento | gcp-docusign-new-auth |
Abilita Cloud Logging | No |
UseSandbox | Sì |
Service account | 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 |
Tipo di connessione OAuth 2.0 - 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ì |
Service account | 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 connessa. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione ti 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 connesso. 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 del 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
una delle seguenti operazioni su un'entità:
Selezionando un'entità dall'elenco disponibile, viene generato 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 alcuna delle operazioni sulle entità, queste operazioni non supportate non sono elencate nell'elenco
Operations
. - Azione: un'azione è una funzione di prima classe resa disponibile per l'integrazione
tramite l'interfaccia del connettore. Un'azione ti consente di apportare modifiche a una o più entità e
varia da connettore a connettore. In genere, un'azione ha 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 di sistema
Il connettore DocuSign può elaborare 3 transazioni al secondo, per nodo, e limita qualsiasi transazione oltre questo limite. Per impostazione predefinita, Integration Connectors alloca due nodi (per una migliore disponibilità) per una connessione.
Per informazioni sui limiti applicabili a Integration Connectors, vedi Limiti.
Azioni
Questa sezione elenca tutte le azioni supportate dalla connessione DocuSign.
Azione CreateAndSendEnvelope
Crea e invia una busta o crea una bozza di busta.
Parametri di input dell'azione CreateAndSendEnvelope
Nome parametro | Tipo di dati | Obbligatorio | Descrizione |
---|---|---|---|
FileName | Stringa | Sì | Il nome del documento. |
DocumentId | Stringa | Sì | ID del documento. |
EmailSubject | Stringa | Sì | La riga dell'oggetto dell'email. |
Contenuti | Stringa | Sì | I contenuti del file. |
SignersEmail | Stringa | No | Gli ID email dei firmatari del documento. |
SignersRecipientId | Stringa | No | Gli ID destinatario dei firmatari. |
CcRecipientId | Stringa | No | Gli ID destinatario dei destinatari in copia conoscenza nell'email. |
CcEmail | Stringa | No | Gli ID email dei destinatari in copia conoscenza dell'email. |
Stato | Stringa | No | Lo stato della busta. Imposta lo stato su "Inviato" per inviare la busta ai destinatari. |
CustomFieldAggregate | Stringa | No | Puoi utilizzare le seguenti colonne: CustomFieldName, CustomFieldId, CustomFieldShow, CustomFieldRequired, CustomFieldValue, CustomFieldConfiguration e CustomFieldListItems. |
SignersName | Stringa | No | Nome dei firmatari del documento. |
CcName | Stringa | No | Nome dei destinatari in Cc. |
Per un esempio di come configurare l'azione CreateAndSendEnvelope
,
consulta Esempi.
Esempi di azioni
Questa sezione descrive come eseguire alcune delle azioni in questo connettore.
Esempio: CreateAndSendEnvelope
Questa azione crea e invia una busta o crea una bozza di busta.
- Nella finestra di dialogo
Configure connector task
, fai clic suActions
. - Seleziona l'azione
CreateAndSendEnvelope
, quindi fai clic su Fine. - Nella sezione Input attività dell'attività Connettori, fai clic su
connectorInputPayload
e poi inserisci un valore simile al seguente nel campoDefault Value
:{ "EmailSubject": "Please Sign this Document", "FileName": "test.txt\ntest.pdf", "SignersEmail": "cloudysanfrancisco@gmail.com", "SignersRecipientId": "53386460", "CcRecipientId": "67173451", "CcEmail": "baklavainthebalkans@gmail.com", "DocumentId": "1", "Status": "sent", "CustomFieldAggregate": "CustomFieldName", "ContentBytes": "abcd***", "HasBytes": true, "SignersName": "\"test\"", "CcName": "\"test\"", "Content": "test content in file" }
Se l'azione ha esito positivo, il
parametro di risposta
connectorOutputPayload
dell'attività
del connettore avrà un valore simile al seguente:
[{ "Success":"true", "envelopeid":"542a77ff-b533-4b39-9d82-e397ef5a70c9", "uri":"/envelopes/542a77ff-b533-4b39-9d82-e397ef5a70c9", "statusdatetime":"2025-04-09T12:33:47.1130000Z", "status":"sent", "customfieldaggregate": "CustomFieldName" }]
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 univoco della chiave primaria che deve essere trasmesso.
Esempio: operazione LIST per l'entità "Accounts"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Account dall'elenco
Entity
. - Seleziona l'operazione
LIST
, quindi 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à "Documents"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Documenti dall'elenco
Entity
. - Seleziona l'operazione
LIST
, quindi 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à "Buste"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Buste dall'elenco
Entity
. - Seleziona l'operazione
LIST
, quindi 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
, quindi 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à "Groups"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Gruppi dall'elenco
Entity
. - Seleziona l'operazione
LIST
, quindi 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à "Users"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Utenti dall'elenco
Entity
. - Seleziona l'operazione
LIST
, quindi 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 di un 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
, quindi 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, quindi inserisci
2.4578824E7
nel campo Valore di input e scegli EntityId come variabile locale.
Esempio: GET di un singolo record per l'entità "Documents"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Documenti dall'elenco
Entity
. - Seleziona l'operazione
LIST
, quindi fai clic su Fine. - Per impostare la clausola di filtro, nella sezione Data Mapper di Mappatura dei dati, fai clic su Apri editor mappatura dei dati, 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 di un singolo record per l'entità "Buste"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Buste dall'elenco
Entity
. - Seleziona l'operazione
GET
, quindi 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, quindi inserisci
8e18be14-3254-4cbe-947d-f0d1cd62f5f87
nel campo Valore di input e scegli EntityId come variabile locale.
Esempio: GET di un 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
, quindi 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, quindi inserisci
05f76d13-a513-492b-8c58-176702768db0
nel campo Valore di input e scegli EntityId come variabile locale.
Esempio: GET di un singolo record per l'entità "Groups"
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Gruppi dall'elenco
Entity
. - Seleziona l'operazione
GET
, quindi 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, quindi inserisci
1.4167231E7
nel campo Valore di input e scegli EntityId come variabile locale.
Esempio: GET di un 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
, quindi 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, quindi 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
Creare connessioni utilizzando Terraform
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 della connessione, consulta 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 | SECRET | Falso | Una password da utilizzare per l'autenticazione al proxy ProxyServer. |
Utilizzare la connessione DocuSign in un'integrazione
Una volta creata la connessione, questa diventa disponibile sia in Apigee Integration che in Application Integration. Puoi utilizzare la connessione in un'integrazione tramite l'attività Connettori.
- Per capire come creare e utilizzare l'attività Connettori in Apigee Integration, consulta Attività Connettori.
- Per capire 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 di 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 dei connettori.