DocuSign
Utilisez le connecteur DocuSign pour effectuer des opérations de lecture sur DocuSign.
Avant de commencer
Avant d'utiliser le connecteur DocuSign, effectuez les tâches suivantes :
- Dans votre projet Google Cloud :
- Assurez-vous que la connectivité réseau est configurée. Pour en savoir plus sur les schémas de réseau, consultez Connectivité réseau.
- Attribuez le rôle IAM roles/connectors.admin à l'utilisateur qui configure le connecteur.
- Attribuez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le connecteur :
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
Un compte de service est un type spécial de compte Google destiné à représenter un utilisateur non humain qui doit s'authentifier et obtenir les autorisations permettant d'accéder aux données des API Google. Si vous ne possédez pas de compte de service, vous devez en créer un. Pour plus d'informations, consultez Créer un compte de service.
- Activez les services suivants :
secretmanager.googleapis.com
(API Secret Manager)connectors.googleapis.com
(API Connectors)
Pour savoir comment activer des services, consultez Activer des services.
Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer au moment de configurer le connecteur.
Configurer le connecteur
Une connexion est propre à une source de données. Cela signifie que si vous disposez de nombreuses sources de données, vous devez créer une connexion distincte pour chacune d'elles. Pour créer une connexion, procédez comme suit :
- Dans la console Cloud, accédez à la page Connecteurs d'intégration > Connexions, puis sélectionnez ou créez un projet Google Cloud.
- Cliquez sur + CRÉER pour ouvrir la page Créer une connexion.
- Dans la section Emplacement, choisissez l'emplacement de la connexion.
- Région : sélectionnez un emplacement dans la liste déroulante.
Pour obtenir la liste de toutes les régions disponibles, consultez Emplacements.
- Cliquez sur SUIVANT.
- Région : sélectionnez un emplacement dans la liste déroulante.
- Dans la section Détails de la connexion, procédez comme suit :
- Connecteur : sélectionnez DocuSign dans la liste déroulante des connecteurs disponibles.
- Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
- Dans le champ Nom de connexion, indiquez le nom de l'instance de connexion.
Les noms de connexion doivent répondre aux critères suivants :
- Ils peuvent contenir des lettres, des chiffres ou des traits d'union.
- Les lettres doivent être en minuscules.
- Ils doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
- Ils ne peuvent pas dépasser 49 caractères.
- (Facultatif) Saisissez une description de l'instance de connexion.
- (Facultatif) Activez Cloud Logging, puis sélectionnez un niveau de journalisation. Par défaut, le niveau de journalisation est défini sur
Error
. - Compte de service : sélectionnez un compte de service disposant des rôles requis.
- Si vous utilisez un compte bac à sable DocuSign, vous pouvez sélectionner UseSandbox.
- (Facultatif) Configurez les paramètres de nœuds de connexion :
- Nombre minimal de nœuds : saisissez le nombre minimal de nœuds de connexion.
- Nombre maximal de nœuds : saisissez le nombre maximal de nœuds de connexion.
Un nœud est une unité (ou instance répliquée) de connexion qui traite des transactions. Pour traiter davantage de transactions pour une connexion, vous devez disposer de plus de nœuds. À l'inverse, moins de nœuds sont nécessaires si une connexion traite moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez Tarifs des nœuds de connexion. Si vous ne saisissez aucune valeur, le nombre minimal de nœuds est défini par défaut sur 2 (pour améliorer la disponibilité) et le nombre maximal de nœuds sur 50.
- (Facultatif) Cliquez sur + AJOUTER UNE ÉTIQUETTE pour ajouter une étiquette à la connexion sous la forme d'une paire clé/valeur.
- Cliquez sur SUIVANT.
-
Dans la section Authentification, saisissez les informations d'authentification.
- Sélectionnez un type d'authentification, puis saisissez les informations appropriées.
Les types d'authentification suivants sont compatibles avec la connexion DocuSign :
- Code d'autorisation OAuth 2.0
- Jeton de support JWT OAuth 2.0
- Cliquez sur SUIVANT.
Pour savoir comment configurer ces types d'authentification, consultez Configurer l'authentification.
- Sélectionnez un type d'authentification, puis saisissez les informations appropriées.
- Vérifier : vérifiez vos informations de connexion et d'authentification.
- Cliquez sur Créer.
Configurer l'authentification
Saisissez les informations en fonction de l'authentification que vous souhaitez utiliser.
- Code d'autorisation OAuth 2.0
- ID client : ID client utilisé pour demander des jetons d'accès.
- Niveaux d'accès : liste des niveaux d'accès souhaités, séparés par une virgule.
- Code secret du client : secret Secret Manager contenant le code secret du client pour l'application connectée que vous avez créée.
- Jeton de support JWT OAuth 2.0
- Clé client de l'application connectée : clé client fournie pour l'application connectée que vous avez créée.
- Nom d'utilisateur : nom d'utilisateur associé à l'application connectée que vous avez créée.
- Clé privée : secret Secret Manager contenant le contenu du fichier de clé privée. La clé privée doit correspondre à la clé publique/au certificat fournis au connecteur.
Exemples de configuration de connexion
Cette section présente des exemples de valeurs pour les différents champs que vous configurez lorsque vous créez la connexion.
Type de connexion avec un code d'autorisation OAuth 2.0
Nom du champ | Détails |
---|---|
Emplacement | us-central1 |
Connecteur | DocuSign |
Version du connecteur | 1 |
Nom de connexion | gcp-docusign-new-auth |
Activer Cloud Logging | Non |
UseSandbox | Oui |
Compte de service | NOM_COMPTE_SERVICE@développeur.compteserviceg.com |
Authentification | Code d'autorisation OAuth 2.0 |
ID client | 67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79 |
Niveaux d'accès | signature |
Code secret du client | SECRET_CLIENT |
Version du secret | 1 |
Type de connexion avec un jeton de support JWT OAuth 2.0
Nom du champ | Détails |
---|---|
Emplacement | us-central1 |
Connecteur | DocuSign |
Version du connecteur | 1 |
Nom de connexion | gcp-docusign-token |
Activer Cloud Logging | Non |
UseSandbox | Oui |
Compte de service | NOM_COMPTE_SERVICE@développeur.compteserviceg.com |
Authentification | Jeton de support JWT OAuth 2.0 |
Clé client de l'application connectée | 67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79 |
Nom d'utilisateur | NOM_UTILISATEUR |
Clé privée | CLÉ_PRIVÉE |
Version du secret | 1 |
Entités, opérations et actions
Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que par le biais de cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.
- Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connectés. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, alors que dans un connecteur de serveur de fichiers, ce sont les dossiers, et dans un connecteur de système de messagerie, ce sont les files d'attente.
Toutefois, il est possible qu'un connecteur n'accepte ou ne possède aucune entité. Dans ce cas, la liste
Entities
est vide. - Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Voici les opérations possibles :
Lorsque vous sélectionnez une entité dans la liste proposée, cela génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche "Connecteurs". Cependant, si un connecteur n'accepte pas l'une des opérations d'entité, cette opération non compatible ne figure pas dans la liste
Operations
. - Action : une action est une fonction de première classe mise à la disposition de l'intégration par le biais de l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et un paramètre de sortie. Toutefois, il est possible qu'un connecteur n'accepte aucune action, auquel cas la liste
Actions
est vide.
Limites du système
Le connecteur DocuSign peut traiter trois transactions par seconde et par nœud, et limite les transactions au-delà de ce seuil. Par défaut, Integration Connectors alloue deux nœuds (pour améliorer la disponibilité) à une connexion.
Pour en savoir plus sur les limites applicables à Integration Connectors, consultez Limites.
Actions
Dans cette section, vous trouverez la liste des actions compatibles avec la connexion DocuSign.
Action CreateAndSendEnvelope
Cette action crée et envoie une enveloppe, ou crée un brouillon d'enveloppe.
Paramètres d'entrée de l'action CreateAndSendEnvelope
Nom du paramètre | Type de données | Obligatoire | Description |
---|---|---|---|
FileName | STRING | Oui | Nom du document. |
DocumentId | STRING | Oui | ID du document. |
EmailSubject | STRING | Oui | Objet de l'e-mail. |
Content | STRING | Oui | Contenu du fichier. |
SignersEmail | STRING | Non | ID d'adresse e-mail des signataires du document. |
SignersRecipientId | STRING | Non | ID de destinataire des signataires. |
CcRecipientId | STRING | Non | ID des destinataires mis en copie dans l'e-mail. |
CcEmail | STRING | Non | ID d'adresse e-mail des destinataires mis en copie dans l'e-mail. |
Status | STRING | Non | État de l'enveloppe. Définissez l'état sur "envoyé" pour envoyer l'enveloppe aux destinataires. |
CustomFieldAggregate | STRING | Non | Vous pouvez utiliser les colonnes suivantes : "CustomFieldName", "CustomFieldId", "CustomFieldShow", "CustomFieldRequired", "CustomFieldValue", "CustomFieldConfiguration" et "CustomFieldListItems". |
SignersName | STRING | Non | Noms des signataires du document. |
CcName | STRING | Non | Noms des destinataires en copie. |
Pour obtenir des exemples de configuration de l'action CreateAndSendEnvelope
, consultez Exemples.
Exemples d'actions
Cette section explique comment effectuer certaines actions dans ce connecteur.
Exemple : CreateAndSendEnvelope
Cette action crée et envoie une enveloppe, ou crée un brouillon d'enveloppe.
- Dans la boîte de dialogue
Configure connector task
, cliquez surActions
. - Sélectionnez l'action
CreateAndSendEnvelope
, puis cliquez sur OK. - Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur
connectorInputPayload
, puis saisissez une valeur semblable à la suivante dans le champDefault 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" }
Si l'action aboutit, le paramètre de réponse
connectorOutputPayload
de la tâche "Connecteurs" aura une valeur semblable à la suivante :
[{ "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" }]
Exemples d'opérations d'entité
Cette section explique comment effectuer certaines opérations d'entité dans ce connecteur.
La valeur d'un ID d'entité doit être transmise directement, par exemple 16ab549b-95d7-47cb-b557-c2476ef62d9d
. L'ID 16ab549b-95d7-47cb-b557-c2476ef62d9d
est la valeur de clé primaire unique qui doit être transmise.
Exemple : Opération LIST pour l'entité Accounts
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez "Accounts" dans la liste
Entity
. - Sélectionnez l'opération
LIST
, puis cliquez sur OK. - Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez définir la filterClause selon vos besoins.
Exemple : Opération LIST pour l'entité Documents
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez "Documents" dans la liste
Entity
. - Sélectionnez l'opération
LIST
, puis cliquez sur OK. - Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez définir la filterClause selon vos besoins.
Exemple : Opération LIST pour l'entité Envelopes
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez "Envelopes" dans la liste
Entity
. - Sélectionnez l'opération
LIST
, puis cliquez sur OK. - Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez définir la filterClause selon vos besoins.
Exemple : Opération LIST pour l'entité Folders
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez "Folders" dans la liste
Entity
. - Sélectionnez l'opération
LIST
, puis cliquez sur OK. - Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez définir la filterClause selon vos besoins.
Exemple : Opération LIST pour l'entité Groups
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez "Groups" dans la liste
Entity
. - Sélectionnez l'opération
LIST
, puis cliquez sur OK. - Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez définir la filterClause selon vos besoins.
Exemple : Opération LIST pour l'entité Users
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez "Users" dans la liste
Entity
. - Sélectionnez l'opération
LIST
, puis cliquez sur OK. - Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez définir la filterClause selon vos besoins.
Vous pouvez également effectuer des opérations LIST sur les entités suivantes :
- UserInfo
- UserSignatures
- Workspaces
- Recipients
- AccountBrands
- AccountCustomFields
- EnvelopeTemplates
- EnvelopeAttachments
- EnvelopeConsumerDisclosures
- CloudStorageProviders
- CustomTabs
- Locks
- GroupBrands
- GroupUsers
- PowerForms
- RecipientTabs
- SigningGroups
- SigningGroupUsers
- Templates
Exemple : Opération GET sur un enregistrement unique pour l'entité Accounts
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez "Accounts" dans la liste
Entity
. - Sélectionnez l'opération
GET
, puis cliquez sur OK. - Pour définir l'ID d'entité, dans la section Data Mapper de la tâche Mappage de données, cliquez sur Ouvrir l'éditeur de mappage de données, puis saisissez
2.4578824E7
dans le champ Valeur d'entrée et choisissez "EntityId" comme variable locale.
Exemple : Opération GET sur un enregistrement unique pour l'entité Documents
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez "Documents" dans la liste
Entity
. - Sélectionnez l'opération
LIST
, puis cliquez sur OK. - Pour définir la clause de filtre, dans la section Data Mapper de la tâche Mappage de données, cliquez sur Ouvrir l'éditeur de mappage de données, puis saisissez
Type='envelopes' AND Id='8e18be14-3254-4cbe-947d-f0d1cd62f5f8'
dans le champ Valeur d'entrée et sélectionnez la clause de filtre comme variable locale.
Exemple : Opération GET sur un enregistrement unique pour l'entité Envelopes
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez "Envelopes" dans la liste
Entity
. - Sélectionnez l'opération
GET
, puis cliquez sur OK. - Pour définir l'ID d'entité, dans la section Data Mapper de la tâche Mappage de données, cliquez sur Ouvrir l'éditeur de mappage de données, puis saisissez
8e18be14-3254-4cbe-947d-f0d1cd62f5f87
dans le champ Valeur d'entrée et choisissez "EntityId" comme variable locale.
Exemple : Opération GET sur un enregistrement unique pour l'entité Folders
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez "Folders" dans la liste
Entity
. - Sélectionnez l'opération
GET
, puis cliquez sur OK. - Pour définir l'ID d'entité, dans la section Data Mapper de la tâche Mappage de données, cliquez sur Ouvrir l'éditeur de mappage de données, puis saisissez
05f76d13-a513-492b-8c58-176702768db0
dans le champ Valeur d'entrée et choisissez "EntityId" comme variable locale.
Exemple : Opération GET sur un enregistrement unique pour l'entité Groups
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez "Groups" dans la liste
Entity
. - Sélectionnez l'opération
GET
, puis cliquez sur OK. - Pour définir l'ID d'entité, dans la section Data Mapper de la tâche Mappage de données, cliquez sur Ouvrir l'éditeur de mappage de données, puis saisissez
1.4167231E7
dans le champ Valeur d'entrée et choisissez "EntityId" comme variable locale.
Exemple : Opération GET sur un enregistrement unique pour l'entité Users
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez "Users" dans la liste
Entity
. - Sélectionnez l'opération
GET
, puis cliquez sur OK. - Pour définir l'ID d'entité, dans la section Data Mapper de la tâche Mappage de données, cliquez sur Ouvrir l'éditeur de mappage de données, puis saisissez
16ab549b-95d7-47cb-b557-c2476ef62d9d
dans le champ Valeur d'entrée et choisissez "EntityId" comme variable locale.
Vous pouvez également effectuer des opérations GET sur les entités suivantes :
- UserInfo
- UserSignatures
- Workspaces
- Recipients
- AccountBrands
- AccountCustomFields
- EnvelopeTemplates
- EnvelopeAttachments
- EnvelopeConsumerDisclosures
- CloudStorageProviders
- CustomTabs
- Locks
- GroupBrands
- GroupUsers
- RecipientTabs
- SigningGroups
- SigningGroupUsers
- Templates
Utiliser Terraform pour créer des connexions
Vous pouvez utiliser la ressource Terraform pour créer une connexion.Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez Commandes Terraform de base.
Pour afficher un exemple de modèle Terraform permettant de créer une connexion, consultez Exemple de modèle.
Lorsque vous créez cette connexion à l'aide de Terraform, vous devez définir les variables suivantes dans votre fichier de configuration Terraform :
Nom du paramètre | Type de données | Obligatoire | Description |
---|---|---|---|
proxy_enabled | BOOLEAN | False | Cochez cette case afin de configurer un serveur proxy pour la connexion. |
proxy_auth_scheme | ENUM | False | Type d'authentification à utiliser pour s'authentifier auprès du proxy ProxyServer. Valeurs acceptées : BASIC, DIGEST et NONE. |
proxy_user | STRING | False | Nom d'utilisateur permettant de s'authentifier auprès du proxy ProxyServer. |
proxy_password | SECRET | False | Mot de passe à utiliser pour s'authentifier auprès du proxy ProxyServer. |
Utiliser la connexion DocuSign dans une intégration
Une fois la connexion créée, elle devient disponible dans Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration au moyen de la tâche "Connecteurs".
- Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez Tâche "Connecteurs".
- Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Application Integration, consultez Tâche "Connecteurs".
Demander de l'aide à la communauté Google Cloud
Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.Étapes suivantes
- Découvrez comment suspendre et reprendre une connexion.
- Découvrez comment surveiller l'utilisation des connecteurs.
- Découvrez comment afficher les journaux des connecteurs.