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 :
  • Accorder à l'utilisateur le rôle IAM roles/connectors.admin configuration du 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 compte Google spécial 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 la section 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 la page Activer des services.

  Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer lors de la configuration du connecteur.

Configurer le connecteur

Pour configurer le connecteur, vous devez créer une connexion à votre source de données (système backend). Une connexion est spécifique à 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 :

1. Dans la console Cloud, accédez à la page Integration Connectors > Connections (Connecteurs d'intégration > Connexions), puis sélectionnez ou créez un projet Google Cloud.

   Accéder à la page "Connexions"

2. Cliquez sur + CRÉER pour ouvrir la page Créer une connexion.
3. Dans la section Emplacement, choisissez l'emplacement de la connexion.
   1. Région : sélectionnez un emplacement dans la liste déroulante.

      Pour obtenir la liste de toutes les régions disponibles, consultez la page Emplacements.

   2. Cliquez sur NEXT (Suivant).
4. Dans la section Détails de connexion, procédez comme suit :
   1. Connecteur: sélectionnez DocuSign dans la liste déroulante des connecteurs disponibles.
   2. Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
   3. Dans le champ Nom de connexion, saisissez un nom pour l'instance de connexion.

      Les noms de connexion doivent répondre aux critères suivants :

      • Les noms de connexion peuvent contenir des lettres, des chiffres ou des traits d'union.
      • Les lettres doivent être en minuscules.
      • Les noms de connexion doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
      • Les noms de connexion ne doivent pas dépasser 49 caractères.
   4. Saisissez éventuellement une Description pour l'instance de connexion.
   5. Vous pouvez également activer Cloud Logging, puis sélectionner un niveau de journalisation. Par défaut, le niveau de journalisation est défini sur Error.
   6. Compte de service : sélectionnez un compte de service disposant des rôles requis.
   7. Si vous utilisez un compte de bac à sable DocuSign, vous pouvez sélectionner UseSandbox (Utiliser le bac à sable).
   8. Vous pouvez également configurer les paramètres du nœud 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 plus de transactions pour une connexion, plus de nœuds sont nécessaires. À l'inverse, moins de nœuds sont nécessaires pour traiter moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez la section 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 une meilleure disponibilité) et le nombre maximal sur 50.

   Remarque : Vous ne pouvez personnaliser les valeurs du nœud de connexion que si vous êtes un client facturé à l'usage.
   9. Vous pouvez également cliquer sur + AJOUTER UN LIBELLÉ pour ajouter un libellé à la connexion sous la forme d'une paire clé/valeur.
   10. Cliquez sur NEXT (Suivant).
5. Dans la section Authentification, saisissez les informations d'authentification.
   1. Sélectionnez un type d'authentification, puis saisissez les informations appropriées.

      Les types d'authentification suivants sont compatibles avec la connexion DocuSign :

      • OAUTH 2.0 : code d'autorisation
      • OAuth 2.0 : jeton porteur JWT

   Pour comprendre comment configurer ces types d'authentification, consultez la section Configurer l'authentification.

   2. Cliquez sur NEXT (Suivant).
6. Vérifiez vos informations de connexion et d'authentification.
7. Cliquez sur Créer.

Configurer l'authentification

Saisissez les détails en fonction de l'authentification que vous souhaitez utiliser.

• OAUTH 2.0 – Code d'autorisation
  • ID client : ID client utilisé pour demander des jetons d'accès.
  • Champs d'application : liste des champs d'application souhaités, séparés par une virgule.
  • Code secret du client : secret Secret Manager contenant le code secret client pour l'application connectée que vous avez créée.
• OAuth 2.0 : support JWT
  • 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 que vous configurez lors de la création de la connexion.

OAUTH 2.0 : type de connexion avec code d'autorisation

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	[e-mail]
Authentification	OAuth 2.0 - Code d'autorisation
Identifiant du client	67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
Niveaux d'accès	signature
Code secret du client	CLIENT_SECRET
Version de secret	1

OAuth 2.0 – Type de connexion de support JWT

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	[e-mail]
Authentification	OAuth 2.0 – support JWT
Clé client de l'application connectée	67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
Nom d'utilisateur	USER_NAME
Clé privée	PRIVATE_KEY
Version de 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 via cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

Remarque : Vous pouvez afficher les entités, les opérations et les actions d'un connecteur dans la tâche Connecteurs.

• 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é. 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, dans un connecteur de serveur de fichiers, les dossiers sont les entités et, dans un connecteur de système de messagerie, les files d'attente sont les entités.

  Toutefois, il est possible qu'un connecteur ne soit pas compatible 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é. Vous pouvez effectuer l'une des opérations suivantes sur une entité :
  • Liste
  • Obtenir
  • Créer
  • Mettre à jour
  • Supprimer

  La sélection d'une entité dans la liste disponible 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 de connecteur. Toutefois, si un connecteur n'accepte aucune des opérations d'entité, opérations ne sont pas répertoriées dans la liste Operations.

• Action : une action est une fonction de première classe mise à la disposition de l'intégration via 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 ne prenne en charge aucune action, auquel cas la liste Actions est vide.

Remarque : Toutes les entités et les actions sont associées à un schéma. Par exemple, un schéma d'action contient les détails des paramètres tels que les noms des paramètres et le type de données correspondant. Le schéma (métadonnées) des entités et des actions est récupéré par la connexion à partir de votre backend. En cas de mises à jour du schéma, elles ne sont pas automatiquement répercutée dans vos connexions existantes. vous devez actualiser le schéma manuellement. Pour actualiser le schéma d'une connexion, ouvrez la page Détails de la connexion de la connexion, puis cliquez sur Actualiser le schéma de connexion.

Limites du système

Le connecteur DocuSign peut traiter trois transactions par seconde et par nœud, et limite les transactions au-delà de cette limite. Par défaut, Integration Connectors alloue deux nœuds (pour une meilleure disponibilité) à une connexion.

Pour en savoir plus sur les limites applicables à Integration Connectors, consultez Limites.

Remarque:Le nombre de nœuds Integration Connectors effectue l'autoscaling de manière dynamique. en fonction de votre utilisation. Toutefois, si vous souhaitez réserver de la capacité pour de grands volumes sans attendre l'autoscaling, vous pouvez ajuster la valeur minimale de nœuds pour une connexion. Plus sont nécessaires pour traiter davantage de transactions pour une connexion. À l'inverse, moins de nœuds sont nécessaires si une connexion traite moins de transactions. Pour configurer les valeurs de nœud, procédez comme suit :

• Si vous êtes un client facturé à l'usage, configurez la valeur minimale et maximale des nœuds sur la page de modification de la connexion.
• Si vous disposez d'un abonnement client, contactez l'assistance.

Le nombre maximal de transactions qu'un nœud peut gérer dépend de plusieurs facteurs. Par conséquent, avant d'ajuster le nombre minimal de nœuds pour améliorer le débit, nous vous recommandons de vérifier si vos systèmes backend sont configurés de manière optimale pour gérer le trafic requis.

Exemples d'opérations sur les entités

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" (Comptes)

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Comptes" dans la liste Entity.
3. Sélectionnez l'opération LIST, puis cliquez sur OK.
4. Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), vous pouvez définir le filterClause selon vos besoins.

Exemple - Opération LIST pour l'entité "Documents"

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Documents" dans la liste Entity.
3. Sélectionnez l'opération LIST, puis cliquez sur OK.
4. Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), vous pouvez définir le filterClause selon vos besoins.

Exemple - Opération LIST pour l'entité "Enveloppes"

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Enveloppes" dans la liste Entity.
3. Sélectionnez l'opération LIST, puis cliquez sur OK.
4. Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), vous pouvez définir le filterClause selon vos besoins.

Exemple : Opération LIST pour l'entité "Dossiers"

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez les dossiers dans la liste Entity.
3. Sélectionnez l'opération LIST, puis cliquez sur OK.
4. Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), vous pouvez définir le filterClause selon vos besoins.

Exemple : Opération LIST pour l'entité "Groups" (Groupes)

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Groupes" dans la liste Entity.
3. Sélectionnez l'opération LIST, puis cliquez sur OK.
4. Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), vous pouvez définir le filterClause selon vos besoins.

Exemple : Opération LIST pour l'entité "Utilisateurs"

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Utilisateurs" dans la liste Entity.
3. Sélectionnez l'opération LIST, puis cliquez sur OK.
4. Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), vous pouvez définir le filterClause selon vos besoins.

Vous pouvez également effectuer des opérations LIST sur les entités suivantes :

• UserInfo
• UserSignatures
• Espaces de travail
• Destinataires
• AccountBrands
• AccountCustomFields
• EnvelopeTemplates
• Pièces jointes d'enveloppe
• EnvelopeConsumerDisclosures
• CloudStorageProviders
• CustomTabs
• Verrous
• GroupBrands
• GroupUsers
• PowerForms
• RecipientTabs
• SigningGroups
• SigningGroupUsers
• Modèles

Exemple : GET un enregistrement unique pour l'entité "Accounts" (Comptes)

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Comptes" dans la liste Entity.
3. Sélectionnez l'opération GET, puis cliquez sur OK.
4. Pour définir l'ID d'entité, dans Dans la section Data Mapper de Data Mapping (Mappage de données), cliquez sur Open Data Mapping Editor (Ouvrir l'éditeur de mappage de données). Ensuite, saisissez 2.4578824E7 dans le champ Input Value (Valeur d'entrée) et sélectionnez EntityId comme variable locale.

Exemple : GET d'un seul enregistrement pour l'entité "Documents"

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Documents" dans la liste Entity.
3. Sélectionnez l'opération LIST, puis cliquez sur OK.
4. Pour définir la clause de filtre, dans la section Data Mapper (Mappeur de données) de la tâche Data Mapping (Mappage de données), cliquez sur Open Data Mapping Editor (Ouvrir l'éditeur de mappage de données), puis saisissez Type='envelopes' AND Id='8e18be14-3254-4cbe-947d-f0d1cd62f5f8' dans le champ Input Value (Valeur d'entrée) et choisissez la clause de filtre comme variable locale.

Exemple - Enregistrement GET unique pour l'entité "Envelopes"

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Enveloppes" dans la liste Entity.
3. Sélectionnez l'opération GET, puis cliquez sur OK.
4. Pour définir l'ID d'entité, dans la section Data Mapper (Mappeur de données) de Data Mapping (Mappage de données), cliquez sur Open Data Mapping Editor (Ouvrir l'éditeur de mappage de données), puis saisissez 8e18be14-3254-4cbe-947d-f0d1cd62f5f87 dans le champ Input Value (Valeur d'entrée) et choisissez EntityId comme variable locale.

Exemple : obtenir un enregistrement unique pour l'entité "Dossiers"

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez les dossiers dans la liste Entity.
3. Sélectionnez l'opération GET, puis cliquez sur OK.
4. Pour définir l'ID d'entité, dans la section Data Mapper (Mappeur de données) de Data Mapping (Mappage de données), cliquez sur Open Data Mapping Editor (Ouvrir l'éditeur de mappage de données), puis saisissez 05f76d13-a513-492b-8c58-176702768db0 dans le champ Input Value (Valeur d'entrée) et choisissez EntityId comme variable locale.

Exemple : GET d'un seul enregistrement pour l'entité "Groupes"

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Groupes" dans la liste Entity.
3. Sélectionnez l'opération GET, puis cliquez sur OK.
4. Pour définir l'ID d'entité, dans Dans la section Data Mapper de Data Mapping (Mappage de données), cliquez sur Open Data Mapping Editor (Ouvrir l'éditeur de mappage de données). Ensuite, saisissez 1.4167231E7 dans le champ Input Value (Valeur d'entrée) et sélectionnez EntityId comme variable locale.

Exemple : GET d'un seul enregistrement pour l'entité "Utilisateurs"

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Utilisateurs" dans la liste Entity.
3. Sélectionnez l'opération GET, puis cliquez sur OK.
4. Pour définir l'ID d'entité, dans la section Data Mapper (Mappeur de données) de Data Mapping (Mappage de données), cliquez sur Open Data Mapping Editor (Ouvrir l'éditeur de mappage de données), puis saisissez 16ab549b-95d7-47cb-b557-c2476ef62d9d dans le champ Input Value (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
• Espaces de travail
• Destinataires
• AccountBrands
• AccountCustomFields
• EnvelopeTemplates
• Pièces jointes d'enveloppe
• EnvelopeConsumerDisclosures
• CloudStorageProviders
• CustomTabs
• Verrous
• GroupBrands
• GroupUsers
• RecipientTabs
• SigningGroups
• SigningGroupUsers
• Modèles

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 la page Commandes Terraform de base.

Pour afficher un exemple de modèle Terraform pour la création de connexions, consultez cet 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	Requis	Description
proxy_enabled	VALEUR BOOLÉENNE	Faux	Cochez cette case pour configurer un serveur proxy pour la connexion.
proxy_auth_scheme	ENUM	Faux	Type d'authentification à utiliser pour s'authentifier auprès du proxy ProxyServer. Les valeurs acceptées sont : BASIC, DIGEST et NONE.
proxy_user	STRING	Faux	Nom d'utilisateur permettant de s'authentifier auprès du proxy ProxyServer.
proxy_password	SECRET	Faux	Mot de passe à utiliser pour l'authentification auprès du proxy ProxyServer.

Utiliser la connexion DocuSign dans une intégration

Une fois la connexion créée, elle devient disponible à la fois Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration via la tâche Connecteurs.

• Pour savoir comment créer et utiliser la tâche Connecteurs dans Apigee Integration, consultez la section Tâche Connecteurs.
• Pour savoir comment créer et utiliser la tâche Connecteurs dans Application Integration, consultez la section Tâche Connecteurs.

Obtenir de l'aide auprès de la communauté Google Cloud

Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.

Étape suivante

• Découvrez comment suspendre et réactiver une connexion.
• Découvrez comment surveiller l'utilisation des connecteurs.
• Découvrez comment afficher les journaux de connecteur.