Micro-apps

Intégrer DocuSign

Déployez l’intégration Citrix DocuSign pour envoyer et recevoir des enveloppes pour les signatures numériques depuis n’importe quel appareil utilisant Citrix Workspace. Les utilisateurs peuvent lancer un nouveau modèle de signature, être informés de tout nouveau document en attente et afficher la liste des enveloppes précédemment envoyées ou reçues dans leur boîte de réception DocuSign.

Remarque :

Ce modèle d’intégration se trouve en version préliminaire et est marqué comme Aperçu dans la liste des modèles disponibles affichés dans le produit lors de l’ajout d’une nouvelle intégration. Lorsqu’un modèle est en version préliminaire, nous ne nous engageons pas à fournir un service de support ; le support est fourni par le développeur de la manière la plus optimale possible. Les modèles d’intégration en version préliminaire sont partagés à des fins de test et de validation. Nous ne conseillons pas de les déployer dans des environnements de production. Pour de plus amples informations, consultez la section Déclaration de maintenance pour les modèles d’intégration de micro-apps.

Pour plus de détails sur la micro-app prête à l’emploi pour DocuSign, consultez la section Utiliser les micro-apps DocuSign.

Vérifier les conditions préalables

Ces conditions préalables supposent que l’administrateur fait partie de la configuration d’intégration DocuSign de l’organisation. Ce compte administrateur DocuSign doit disposer de privilèges de lecture complets sur les informations de l’utilisateur.

Une fois l’intégration avec DocuSign configurée, vous aurez besoin de ces artefacts pour ajouter l’intégration dans les micro-apps Citrix Workspace, en particulier la liste suivante de paramètres pour configurer l’intégration OAuth :

  • URL de base : URL de base à laquelle les chemins d’accès des points de terminaison sont ajoutés. Vous pouvez obtenir l’URL de base à partir du compte de service sous Applications et clés. Format URL de base : {baseURL fetched from sevice account}/restapi/2.1/. Pour savoir comment trouver l’URL de base, consultez Configurer le serveur OAuth.
  • URL d’environnement : par exemple à partir de l’URL de base https://{yourEnvironmentalURL}.docusign.net/restapi/v2.1/.
  • URL d’autorisation : https://account-d.docusign.com/oauth/auth
  • URL du jeton : https://account-d.docusign.com/oauth/token
  • ID du client : l’ID du client permet de définir la chaîne représentant les informations d’inscription client uniques au serveur d’autorisation.
  • Clé secrète client : la clé secrète client permet de définir la chaîne unique générée lors de la configuration de l’intégration de l’application cible.
  • ID de compte API : remplace le paramètre et la variable your_account_ID dans les points de terminaison et les actions de service. Consultez Configurer le serveur OAuth.

Remarque :

Nous vous recommandons de toujours utiliser OAuth 2.0 comme méthode d’authentification de service lorsque cette méthode est disponible. OAuth 2.0 garantit que votre intégration respecte la conformité maximale en matière de sécurité avec votre micro-app configurée.

Configurez Citrix Gateway pour prendre en charge l’authentification unique pour DocuSign : une fois que les utilisateurs se connectent, ils sont automatiquement reconnectés sans avoir à entrer leurs informations d’identification une seconde fois. Pour plus d’informations sur la configuration de l’authentification unique (SSO, Single Sign-On), consultez la section Citrix Gateway Service.

Le nombre de requêtes d’API pouvant être exécutées sur des ressources spécifiques est limité. Nous recommandons donc ce qui suit :

Lien du formulaire spécifiant les limitations de l’API DocuSign : https://developers.docusign.com/docs/esign-soap-api/esign101/security/call-limits/

Créer un compte de service

Inscrivez-vous ici : https://admin.docusign.com. Vous pouvez afficher les profils d’autorisation utilisateur à l’adresse suivante : https://support.docusign.com/en/guides/ndse-admin-guide-permission-sets. Si vous souhaitez accéder à la version de démonstration d’eSignature Admin, utilisez plutôt cette URL : https://admindemo.docusign.com. Pour plus d’informations sur les nouveaux comptes de service, consultez https://support.docusign.com/en/guides/org-admin-guide-getting-started.

Configurer le serveur OAuth

Configurez le serveur OAuth pour lire les données via l’intégration DocuSign.

  1. Connectez-vous à eSignature Admin avec votre compte de service : https://admin.docusign.com. Pour la version de démonstration d’eSignature Admin : https://admindemo.docusign.com. Pour de plus amples informations, consultez https://support.docusign.com/en/guides/ndse-admin-guide-access et https://support.docusign.com/en/guides/ndse-admin-guide-welcome-to-administration.
  2. Accédez à Setting dans la barre de navigation.
  3. Sur la page des paramètres, sélectionnez Apps and Keys, puis ADD APP & INTEGRATION KEY.
  4. Renseignez le champ APP Name et sélectionnez ADD.
  5. Sélectionnez +Add Secret Key pour générer une clé secrète.
  6. Renseignez le champ Redirect URI : https://{yourmicroappserverurl}/admin/api/gwsc/auth/serverContext
  7. Copiez et enregistrez la clé d’intégration et la clé secrète (ClientId et Secret) affichées à l’écran. Vous utilisez ces détails pour l’authentification du service lors de la configuration de l’intégration.
  8. Copiez et enregistrez l’URI de base du compte (Account’s Base URI).
  9. Copiez et enregistrez l’ID de compte API.

Configurer le client OAuth

Configurez le client OAuth pour écrire les données via l’intégration DocuSign.

  1. Connectez-vous à eSignature Admin avec votre compte de service : https://admin.docusign.com. Pour la version de démonstration d’eSignature Admin : https://admindemo.docusign.com. Pour de plus amples informations, consultez https://support.docusign.com/en/guides/ndse-admin-guide-access et https://support.docusign.com/en/guides/ndse-admin-guide-welcome-to-administration.
  2. Accédez à Setting dans la barre de navigation.
  3. Sur la page des paramètres, sélectionnez Apps and Keys, puis ADD APP & INTEGRATION KEY.
  4. Renseignez le champ APP Name et sélectionnez ADD.
  5. Sélectionnez +Add Secret Key pour générer une clé secrète.
  6. Renseignez le champ Redirect URI : https://{yourmicroappserverurl}/app/api/auth/serviceAction/callback
  7. Copiez et enregistrez la clé d’intégration et la clé secrète (ClientId et Secret) affichées à l’écran. Vous utilisez ces détails pour l’authentification des actions de service lors de la configuration de l’intégration.

Configurer l’organisation

Liez des comptes à votre organisation. Le compte que vous avez utilisé pour créer l’organisation est automatiquement lié.

  1. Dans la page d’accueil eSignature Admin, sélectionnez GET STARTED. Si cette option ne s’affiche pas dans votre compte DocuSign, DocuSign Admin n’est pas activé sur le compte. Contactez votre gestionnaire de compte DocuSign pour obtenir de l’aide.
  2. Renseignez Organization Name et Description (champ facultatif) dans les champs fournis, puis sélectionnez NEXT.
  3. Sélectionnez CREATE pour terminer la création de votre organisation. Pour de plus amples informations, consultez la section https://support.docusign.com/en/guides/org-admin-guide-create-org.
  4. Accédez au tableau de bord Organization Admin. Sélectionnez Connected Apps, puis AUTHORIZE APPLICATION.
  5. Sélectionnez le nom de l’application que vous avez entré et créé lors de la configuration du serveur et du client OAuth. Sélectionnez ADD pour fournir des autorisations.
  6. Entrez les étendues requises. Pour plus d’informations, consultez la section https://developers.docusign.com/platform/auth/reference/scopes.
    • Pour l’authentification du service, sélectionnez le nom de l’application que vous avez créé dans Configurer le serveur OAuth, fournissez l’autorisation user_read et sélectionnez ADD.
    • Pour l’authentification des actions de service, sélectionnez le nom de l’application que vous avez créé dans Configurer le client OAuth, fournissez l’autorisation user_write et sélectionnez ADD.

Ajouter l’intégration aux micro-apps Citrix Workspace

Ajoutez l’intégration DocuSign aux micro-apps Citrix Workspace pour vous connecter à votre application. Les options d’authentification sont présélectionnées. Assurez-vous que ces options sont sélectionnées lorsque vous effectuez le processus. Des micro-apps prêtes à l’emploi sont proposées, ainsi que des notifications et des actions préconfigurées qui sont prêtes à être utilisées dans votre espace de travail.

Procédez comme suit :

  1. Sur la page Intégrations de micro-apps, sélectionnez Ajouter nouvelle intégration et Ajouter une nouvelle intégration à partir des modèles fournis par Citrix.
  2. Choisissez la vignette DocuSign.
  3. Donnez un nom d’intégration à l’intégration.
  4. Renseignez la section Paramètres du connecteur.
    • Entrez l’URL de base de l’instance :
    • Sélectionnez une icône pour l’intégration dans la bibliothèque d’icônes ou gardez l’icône par défaut.

    Paramètres DocuSign

  5. Sous Authentification du service, sélectionnez OAuth 2.0 dans le menu Méthode d’authentification et complétez les détails d’authentification. Les options d’authentification sont présélectionnées. Assurez-vous que ces options sont sélectionnées lorsque vous effectuez le processus. Utilisez le protocole de sécurité OAuth 2.0 pour générer des jetons de demande/autorisation pour l’accès délégué. Il est recommandé de toujours utiliser OAuth 2.0 comme méthode d’authentification de service lorsque cette méthode est disponible. OAuth 2.0 garantit que votre intégration respecte la conformité maximale en matière de sécurité avec votre micro-app configurée.

    1. Sélectionnez Code d’autorisation dans le menu Type d’autorisation. Permet d’octroyer un code temporaire que le client échange contre un jeton d’accès. Le code est obtenu à partir du serveur d’autorisation où vous pouvez afficher les informations demandées par le client. Seul ce type d’autorisation permet un emprunt d’identité de l’utilisateur sécurisé. Cela affiche l’URL de rappel que vous utilisez lors de l’enregistrement de votre application.
    2. Sélectionnez Corps de la requête dans le menu Autorisation de jeton.
    3. L’URL d’autorisation est pré-remplie.
    4. L’URL du jeton est pré-remplie.
    5. Assurez-vous que les éléments suivants sont saisis sous Étendue : user_read
    6. Saisissez votre ID client. L’ID du client permet de définir la chaîne représentant les informations d’inscription client uniques au serveur d’autorisation. Vous obtenez cet élément, ainsi que la clé secrète client lorsque vous avez configuré le serveur OAuth. Vous devez ajouter l’URL de rappel que vous voyez sur la page de configuration de l’intégration.
    7. Entrez la Clé secrète client. La clé secrète client permet de définir la chaîne unique générée lors de la configuration de l’intégration de l’application cible.

    Authentification du service

  6. Sous Authentification des actions de service, activez Utiliser authentification utilisateur distincte dans Actions. L’authentification des actions de service s’authentifie au niveau de l’action de service. Les options d’authentification sont présélectionnées. Assurez-vous que ces options sont sélectionnées lorsque vous effectuez le processus.

    1. Sélectionnez OAuth 2.0 dans le menu Méthode d’authentification et complétez les détails d’authentification.
    2. Sélectionnez Code d’autorisation dans le menu Type d’autorisation. Permet d’octroyer un code temporaire que le client échange contre un jeton d’accès. Le code est obtenu à partir du serveur d’autorisation où vous pouvez afficher les informations demandées par le client. Seul ce type d’autorisation permet un emprunt d’identité de l’utilisateur sécurisé. Cela affiche l’URL de rappel que vous utilisez lors de l’enregistrement de votre application.
    3. Sélectionnez Corps de la requête dans le menu Autorisation de jeton.
    4. L’URL d’autorisation est pré-remplie.
    5. L’URL du jeton est pré-remplie.
    6. Assurez-vous que les éléments suivants sont saisis sous Étendue : user_write
    7. Saisissez votre ID client. L’ID du client permet de définir la chaîne représentant les informations d’inscription client uniques au serveur d’autorisation. Vous obtenez cet élément, ainsi que la clé secrète client lorsque vous avez configuré le client OAuth. Vous devez ajouter l’URL de rappel que vous voyez sur la page de configuration de l’intégration.
    8. Entrez la Clé secrète client. La clé secrète client permet de définir la chaîne unique générée lors de la configuration de l’intégration de l’application cible.

    Authentification des actions de service

  7. Le bouton Activer la limitation du taux de demandes est activé. Laissez 400 pour Nombre de demandes et 1 minute pour Intervalle de temps. Le champ Délai d’expiration de la demande est défini sur 120 par défaut.
  8. (Facultatif) Activez la fonction Journalisation pour conserver 24 heures de journalisation à des fins de support.

    Authentification du service

  9. Sélectionnez Enregistrer pour continuer.
  10. Sous Autorisation OAuth, sélectionnez Autoriser pour vous connecter avec votre compte de service. Une fenêtre contextuelle apparaît avec un écran de connexion Google.
    1. Entrez le nom d’utilisateur et le mot de passe de votre compte de service, puis sélectionnez Connexion.
    2. Sélectionnez Accepter.

    Autoriser

Remplacer les variables Chargement de données et Action de service

Pour terminer cette configuration, vous devez remplacer le paramètre et la variable account_Id dans tous les points de terminaison et les actions de service par la valeur ID de compte API que vous avez obtenue lors de l’étape Configurer le serveur OAuth.

Remplacer les variables Chargement des données

Pour chaque point de terminaison de données, vous devez remplacer manuellement la valeur {yourAccountId} par votre variable account_Id. Vous effectuez cette opération pour les trois points de terminaison : Enveloppes, Modèles et Utilisateurs.

  1. Sur la page Intégrations de micro-apps, sélectionnez le menu en regard de l’intégration Podio, puis Modifier. L’écran Chargement des données s’ouvre. Si vous êtes sur l’écran de configuration, sélectionnez Chargement des données dans la colonne de navigation gauche.
  2. Sélectionnez le menu en regard du premier point de terminaison, puis sélectionnez Modifier ou sélectionnez le nom du point de terminaison.

    Points de terminaison DocuSign

  3. Sur l’écran Modifier le point de terminaison de données, sous Variables de modèle, remplacez la valeur {yourAccountId} par votre ID de compte API.
  4. Sélectionnez Appliquer en bas de l’écran et confirmez vos sélections.

    Remplacer accountID

  5. Répétez maintenant cette opération pour les deux autres points de terminaison de données. N’oubliez pas de sélectionner Appliquer en bas de l’écran pour confirmer chaque modification.

Remplacer les variables Action de service

Pour chaque action de service, vous devez remplacer manuellement la valeur {yourAccountId} par le paramètre et la variable account_Id. Remplacez {yourAccountId} dans Paramètres d’action de service pour les actions de service suivantes : Add_Recipient et Resend_Envelope. Remplacez {yourAccountId} dans Variables de modèle pour les actions de service suivantes : Delete_Recipient, Send_Template_One_Recipient, Send_Template_Three_Recipients, Send_Template_Two_Recipientset Update_Recipient.

  1. Lors de la modification de la configuration de l’intégration, sélectionnez Actions de service dans la colonne de navigation gauche.
  2. Sélectionnez le menu situé en regard de la première action de service, puis sélectionnez Modifier, ou sélectionnez le nom de l’action de service.

    Actions de service DocuSign

  3. Sur l’écran Modifier l’action de service, sous Paramètres, recherchez {yourAccountId}.
  4. Sous Variables de modèle, remplacez la valeur {yourAccountId} par votre variable account_Id.

    Variable de modèle

  5. Sélectionnez Enregistrer pour terminer le processus
  6. Répétez maintenant cette opération pour les autres actions de service. N’oubliez pas de sélectionner Enregistrer en bas de l’écran pour confirmer chaque modification.

Ajouter des actions aux boutons

Configurez les actions Aller à l’URL pour les boutons suivants pour activer les fonctionnalités des boutons Signer l’enveloppe et Afficher l’enveloppe. Cette configuration Aller à l’URL redirige l’action utilisateur vers la page détaillée de l’enveloppe spécifique dans DocuSign.

  1. Accédez aux boutons suivants, puis sélectionnez-les dans le générateur de pages. Effectuez cette procédure pour chaque bouton ci-dessous :

    • Micro-app Mes enveloppes reçues > Page Détails de l’enveloppe en attente > Bouton Signer l’enveloppe
    • Micro-app Mes enveloppes envoyées > Page Vue du destinataire de l’enveloppe > Bouton Signer l’enveloppe
    • Micro-app Mes enveloppes envoyées > Page Vue de l’expéditeur de l’enveloppe > Bouton Afficher l’enveloppe
  2. Sélectionnez l’onglet Actions à droite.
  3. Sous Actions, sélectionnez Aller à l’URL.
  4. Dans le champ Modèle d’URL, remplacez la partie de l’URL {yourEnvironmentName} par votre URL d’environnement. Affichez votre URL d’environnement dans votre URL de base : https://{yourEnvironmentName}.docusign.net/restapi/v2.1/. Par exemple : https://appdemo.docusign.com/documents/details/\{\{nested_table_envelopes_recipients_sign.envelope_id\}\}.

    URL d'environnement

  5. Maintenant, répétez cette procédure pour les autres boutons.

Vous êtes maintenant prêt à définir et exécuter votre première synchronisation de données. Pour plus d’informations sur les règles de synchronisation, ainsi que sur la synchronisation qui ne respecte pas ses règles de planification et de veto, consultez la section Synchroniser les données.

Pour plus d’informations sur les points de terminaison d’API et les entités de table, consultez la section Spécifications du connecteur DocuSign.

Utiliser les micro-apps DocuSign

Les intégrations d’application existantes sont fournies avec des micro-apps prêtes à l’emploi. Commencez avec ces micro-apps et personnalisez-les en fonction de vos besoins.

Remarque :

Pour activer les fonctionnalités des boutons Signer l’enveloppe et Afficher l’enveloppe, remplacez le bouton Action pour les pages Détails de l’enveloppe en attente, Vue du destinataire de l’enveloppe et Vue de l’expéditeur de l’enveloppe par votre URL d’environnement. Consultez Ajouter des actions aux boutons.

Mes enveloppes reçues : permet d’afficher les enveloppes reçues par l’utilisateur qui sont en attente de signature. L’utilisateur peut s’authentifier et afficher l’enveloppe dans DocuSign.

Notification ou Page Workflows de cas d’utilisation
Page Mes enveloppes en attente Fournit un tableau de toutes les enveloppes en attente de signature de l’utilisateur, ainsi que l’option de recherche permettant de filtrer les enveloppes par objet de l’e-mail ou par nom de l’expéditeur. Les utilisateurs peuvent afficher les enveloppes correspondant à l’état Envoyé et Livré.
Page Détails de l’enveloppe en attente Fournit les détails associés à une enveloppe en attente de signature, tels que l’objet de l’e-mail, le nom de l’expéditeur et le délai d’expiration (nombre de jours). Les utilisateurs peuvent afficher l’enveloppe dans DocuSign à l’aide du bouton Signer l’enveloppe.

Envoyer un modèle : permet d’envoyer un modèle de sortie pour signature.

Notification ou Page Workflows de cas d’utilisation
Page Tous les modèles Fournit un tableau de tous les modèles de l’utilisateur. L’intégration ne répertorie pas les modèles partagés dans la liste des modèles de l’utilisateur connecté.
Page Détails du modèle Fournit un formulaire permettant d’envoyer le modèle aux destinataires. L’expéditeur fournit les informations suivantes pour envoyer une enveloppe : Nom, Adresse e-mail et Rôle. Les enveloppes peuvent être envoyées à un nombre maximal de trois (3) destinataires à la fois. Un modèle doit contenir un document pour envoyer une enveloppe à l’aide de ce modèle.

Mes enveloppes envoyées : permet d’afficher la liste des enveloppes envoyées par l’utilisateur. Les utilisateurs peuvent également afficher les détails de l’enveloppe, ainsi qu’ajouter, modifier et supprimer des destinataires.

Remarque :

Les notifications expirent deux jours après leur création.

Notification ou Page Workflows de cas d’utilisation
Notification Changement de l’état de l’enveloppe Lorsque l’état d’une enveloppe passe sur Terminé ou Refusé, une notification est générée et envoyée à l’expéditeur de l’enveloppe. Si l’état d’une enveloppe est déjà défini sur Terminé ou Refusé lorsque l’enregistrement est ajouté à la base de données de micro-apps Citrix, la notification n’est pas générée ni envoyée à l’expéditeur.
Notification Nouvelle enveloppe Lorsqu’une nouvelle enveloppe est reçue, l’état de l’enveloppe et du destinataire doit être défini sur Envoyé ou Livré, et une notification est générée et envoyée au destinataire associé.
Page Ajouter un destinataire Fournit un formulaire permettant d’ajouter un destinataire à une enveloppe. Contient des champs de saisie tels que Nom, Adresse e-mail et Rôle.
Page Modifier le destinataire Fournit un formulaire permettant de modifier les champs de saisie tels que le nom et l’adresse e-mail. Lorsqu’un utilisateur modifie un nom ou une adresse e-mail, un bouton Enregistrer et renvoyer s’affiche et un e-mail est envoyé au destinataire.
Page Détails de l’enveloppe Fournit des détails sur l’enveloppe tels que l’objet de l’e-mail, la date de création et l’état. Affiche également la liste des destinataires associés à l’enveloppe, ainsi qu’un bouton Ajouter un destinataire. Les utilisateurs ne peuvent pas modifier ou ajouter des destinataires à des enveloppes annulées ou refusées.
Page Mes enveloppes Fournit la liste de toutes les enveloppes envoyées par l’utilisateur disposant d’un état (Envoyé, Livré, Terminé, Refusé, Annulé), ainsi qu’une barre de recherche permettant de filtrer les enveloppes par objet de l’e-mail ou par état de l’enveloppe.
Page Détails du destinataire Fournit les détails du destinataire, tels que le nom, l’adresse e-mail et l’état, ainsi que les boutons suivants : Modifier le destinataire, Renvoyer l’enveloppe et Supprimer le destinataire.
Page Vue du destinataire de l’enveloppe Fournit les détails associés à une enveloppe en attente de signature, tels que l’objet de l’e-mail, le nom de l’expéditeur et le délai d’expiration (nombre de jours). Les utilisateurs peuvent afficher l’enveloppe dans DocuSign à l’aide du bouton Signer l’enveloppe afin de signer l’enveloppe.
Page Vue de l’expéditeur de l’enveloppe Fournit des détails sur l’enveloppe tels que l’objet de l’e-mail, la date de création et l’état. Contient également une liste des destinataires associés à l’enveloppe et un bouton Afficher l’enveloppe.