Guide d'utilisation Annuler

API Adobe Acrobat Sign : FAQ

Rechercher
Adobe Sign

Adobe Sign

Ouvrir l’application

 

Guide Adobe Acrobat Sign

Nouveautés

  1. Notes de version préliminaire
  2. Notes de mise à jour
  3. Notifications importantes

Commencer

  1. Guide de démarrage rapide à l’attention des administrateurs
  2. Guide de démarrage rapide à l’attention des utilisateurs
  3. Pour les développeurs
  4. Bibliothèque de tutoriels vidéo
  5. Foire aux questions

Administration

  1. Présentation d’Admin Console
  2. Gestion des utilisateurs
    1. Ajout d’utilisateurs
      1. Ajout d’un utilisateur
      2. Ajout d’utilisateurs en masse
      3. Ajout d’utilisateurs à partir de votre répertoire
      4. Ajout d’utilisateurs à partir de Microsoft Azure Active Directory
    2. Création d’utilisateurs axés sur les fonctions
      1. Comptes techniques - Pilotés par API
      2. Comptes de service - Pilotés manuellement
    3. Recherche d’utilisateurs présentant des erreurs d’approvisionnement
    4. Modification du nom/de l’adresse e-mail
    5. Modification de l’appartenance d’un utilisateur à un groupe
    6. Modification de l’appartenance d’un utilisateur à un groupe via l’interface de groupe
    7. Promotion d’un utilisateur à un rôle d’administrateur
    8. Types d’identités des utilisateurs et SSO
    9. Changement d’identité d’utilisateur
    10. Authentification des utilisateurs avec Microsoft Azure
    11. Authentification des utilisateurs avec la fédération Google
    12. Profils de produit
    13. Expérience de connexion
  3. Paramètres de compte/groupe
    1. Présentation des paramètres
    2. Paramètres généraux
      1. ID et niveau de compte
      2. Nouvelle expérience pour les destinataires
      3. Workflows de signature automatique
      4. Envoi en masse
      5. Formulaires web
      6. Workflows d’envoi personnalisés
      7. Workflows Power Automate
      8. Documents de bibliothèque
      9. Collecte des données de formulaire avec les accords
      10. Visibilité limitée de documents
      11. Ajout d’une copie PDF de l’accord signé en pièce jointe
      12. Insertion d’un lien dans l’e-mail
      13. Insertion d’une image dans l’e-mail
      14. Fichiers joints à un e-mail nommés
      15. Ajout de rapports d’audit aux documents en pièces jointes
      16. Fusion de plusieurs documents en un seul
      17. Téléchargement de documents individuels
      18. Chargement d’un document signé
      19. Délégation pour les utilisateurs de mon compte
      20. Autorisation de la délégation des destinataires externes
      21. Autorisation de signature
      22. Autorisation d’envoi
      23. Pouvoir d’ajouter des cachets électroniques
      24. Définition d’un fuseau horaire par défaut
      25. Définition d’un format de date par défaut
      26. Utilisateurs dans plusieurs groupes (UMG)
        1. Mise à niveau pour utiliser la fonctionnalité Utilisateurs dans plusieurs groupes
      27. Autorisations d’administrateur de groupe
      28. Remplacement du destinataire
      29. Rapport d’audit
        1. Présentation
        2. Autorisation des accès non authentifiés sur la page de vérification des transactions
        3. Inclusion des rappels
        4. Insertion des événements de consultation
        5. Inclusion du nombre de pages/pièces jointes de l’accord
      30. Pied de page de la transaction
      31. Dans les messages et les conseils sur les produits
      32. PDF accessibles
      33. Nouvelle expérience de création
      34. Client du secteur de la santé
    3. Configuration du compte
      1. Ajout d’un logo
      2. Personnalisation du nom d’hôte/de l’URL de la société
      3. Ajout du nom de l’entreprise
      4. Redirection d’URL une fois l’accord complété
    4. Préférences de signature
      1. Signatures correctement formatées
      2. Autorisation des destinataires à signer par
      3. Possibilité pour les signataires de modifier leur nom
      4. Autorisation des destinataires à utiliser leur signature enregistrée
      5. Personnalisation des conditions d’utilisation et de la règle concernant la divulgation des informations de l’utilisateur
      6. Navigation des destinataires dans les champs de formulaire
      7. Redémarrage du workflow de l’accord
      8. Refus de signer
      9. Autorisation des processus avec tampons
      10. Ajout de la fonction ou la société obligatoire pour les destinataires
      11. Autorisation des signataires à imprimer et à apposer une signature manuscrite
      12. Affichage des messages lors de la signature électronique
      13. Obligation pour les signataires d’utiliser un appareil mobile pour créer leur signature
      14. Adresse IP des signataires requise
      15. Exclusion du nom de la société et de la fonction des tampons de participation
    5. Signatures numériques
      1. Présentation
      2. Téléchargement et signature d’un document avec Acrobat
      3. Signatures en mode cloud
      4. Inclure les métadonnées pour les fournisseurs d’identité
      5. Fournisseurs de signature en mode cloud restreints
    6. Cachets électroniques
    7. Identité numérique
      1. Passerelle d’identités numériques
      2. Politique de vérification d’identité
    8. Paramètres de rapport
      1. Nouvelle expérience de rapport
      2. Paramètres de rapport classiques
    9. Paramètres de sécurité
      1. Paramètres d’authentification unique
      2. Paramètres de mémorisation
      3. Politique de mot de passe de connexion
      4. Sécurité du mot de passe de connexion
      5. Durée de la session web
      6. Type de chiffrement PDF
      7. API
      8. Accès aux informations sur les utilisateurs et les groupes
      9. Plages d’adresses IP autorisées
      10. Partage de compte
      11. Autorisations de partage de compte
      12. Commandes de partage d’accords
      13. Vérification de l’identité des signataires
      14. Mot de passe de signature des accords
      15. Sécurité du mot de passe du document
      16. Blocage des signataires par géolocalisation
      17. Authentification téléphonique
      18. Authentification basée sur les connaissances (KBA)
      19. Autorisation de l’extraction de pages
      20. Expiration du lien de document
      21. Chargement d’un certificat client pour les webhooks/rappels
      22. Horodatage
    10. Paramètres d’envoi
      1. Affichage de la page Envoyer après la connexion
      2. Nom du destinataire requis lors de l’envoi
      3. Verrouillage des valeurs de nom pour les utilisateurs connus
      4. Rôles autorisés du destinataire
      5. Autorisation des témoins électroniques
      6. Groupes de destinataires
      7. En copie
      8. Accès du destinataire à l’accord
      9. Champs requis
      10. Ajout de documents en pièces jointes
      11. Aplatissement du champ
      12. Modification des accords
      13. Nom de l’accord
      14. Langues
      15. Messages privés
      16. Types de signature autorisés
      17. Rappels
      18. Protection par mot de passe des documents signés
      19. Envoi d’une notification d’accord par
      20. Options d’identification du signataire
        1. Présentation
        2. Mot de passe de signature
        3. Mot de passe à usage unique par e-mail
        4. Authentification Acrobat Sign
        5. Authentification téléphonique
        6. Signature numérique dans le cloud
        7. Authentification fondée sur les connaissances
        8. Pièce d’identité officielle
        9. Rapports d’identité des signataires
      21. Protection du contenu
      22. Activation des transactions Notarize
      23. Expiration du document
      24. Aperçu, positionnement des signatures et ajout de champs
      25. Ordre de signature
      26. Liquid Mode
      27. Commandes de workflow personnalisé
      28. Options de chargement pour la page de signature électronique
      29. Redirection de l’URL de confirmation post-signature
    11. Modèles de message
    12. Paramètres bio-pharma
      1. Présentation
      2. Fonction Appliquer l’authentification de l’identité
      3. Motifs de la signature
    13. Intégration des workflows
    14. Paramètres d’authentification notariale
    15. Intégration des paiements
    16. Messages pour les signataires
    17. Paramètres SAML
      1. Configuration SAML
      2. Installation des services Microsoft Active Directory Federation Services
      3. Installation d’Okta
      4. Installation de OneLogin
      5. Installation d’Oracle Identity Federation
    18. Gouvernance des données
    19. Paramètres d’horodatage
    20. Archive externe
    21. Langues du compte
    22. Paramètres de messagerie
      1. Images d’en-tête et de pied de page d’e-mail
      2. Autorisation de pieds de page dans l’e-mail d’un utilisateur individuel
      3. Personnalisation de l’e-mail « Signature requise »
      4. Personnalisation des champs « À » et « Cc »
      5. Activation des notifications sans lien
      6. Personnalisation des modèles de courrier électronique
    23. Migration d’echosign.com vers adobesign.com
    24. Configuration des options pour les destinataires
  4. Conseils relatifs aux exigences réglementaires
    1. Accessibilité
      1. Conformité de l’accessibilité
      2. Création de formulaires accessibles avec Acrobat pour poste de travail
      3. Création de formulaires AcroForms accessibles
    2. HIPAA
    3. RGPD
      1. Présentation du RGPD
      2. Biffure d’un utilisateur
      3. Biffure des accords d’un utilisateur
    4. 21 CFR Part 11 et EudraLex Annexe 11
      1. Pack de validation 21 CRF Part 11
      2. Manuel 21 CFR et EudraLex Annexe 11
      3. Analyse des responsabilités partagées
    5. Clients du secteur de la santé
    6. Prise en charge du service fiscal Income Verification Express Service (IVES)
    7. Accords « placés dans le coffre »
    8. Considérations relatives à l’Union européenne et au Royaume-Uni
      1. eIDAS et transactions transfrontalières dans l’Union européenne et au Royaume-Uni
      2. Exigences HMLR pour les actes signés électroniquement
      3. Impact du Brexit sur les lois sur les signatures électroniques au Royaume-Uni
  5. Téléchargement d’accords en masse
  6. Dépôt de votre domaine
  7. Liens Signaler un abus

Envoi, signature et gestion des accords

  1. Options du destinataire
    1. Annulation d’un rappel par e-mail
    2. Options de la page de signature électronique
      1. Vue d’ensemble de la page de signature électronique
      2. Ouverture d’un accord pour le lire sans champs
      3. Refus de signer un accord
      4. Délégation de l’autorité de signature
      5. Redémarrage de l’accord
      6. Téléchargement d’un PDF de l’accord
      7. Affichage de l’historique de l’accord
      8. Affichage des messages de l’accord
      9. Conversion d’une signature électronique en signature manuscrite
      10. Conversion d’une signature manuscrite en signature électronique 
      11. Navigation dans les champs de formulaire
      12. Effacement des données des champs de formulaire
      13. Agrandissement de la page de signature électronique et navigation dans la page
      14. Modification de la langue utilisée dans les outils et informations de l’accord
      15. Consultation des informations juridiques
      16. Réglage des préférences d’Acrobat Sign en matière de cookies
  2. Envoi les accords
    1. Présentation de la page Envoyer
    2. Envoi d’un accord uniquement à vous-même
    3. Envoi d’un accord à d’autres utilisateurs
    4. Signatures manuscrites
    5. Ordre de signature des destinataires
    6. Envoi en masse
      1. Vue d’ensemble de la fonction Envoi en masse
      2. Envoi en masse : configuration d’un modèle parent
      3. Envoi en masse : configuration du fichier CSV
      4. Annulation d’une transaction Envoyer en masse
      5. Ajout de rappels à l’Envoi en masse
      6. Rapports pour l’Envoi en masse
  3. Création de champs dans des documents
    1. Environnement de création intégré à l’application
      1. Détection automatique des champs
      2. Glisser-déposer des champs à l’aide de l’environnement de création
      3. Affectation des champs de formulaire aux destinataires
      4. Rôle de préremplissage
      5. Application de champs à l’aide d’un modèle de champ réutilisable
      6. Transfert de champs vers un nouveau modèle de bibliothèque
      7. Mise à jour de l’environnement de création lors de l’envoi d’accords
    2. Création de formulaires avec des balises de texte
    3. Création de formulaires avec Acrobat (AcroForms)
      1. Création d’un formulaire AcroForm
      2. Création de fichiers PDF accessibles
    4. Champs
      1. Types de champ
        1. Types de champs communs
        2. Images intégrées
        3. Tampons
      2. Apparence du contenu d’un champ
      3. Validations des champs
      4. Valeurs des champs masqués
      5. Définition des conditions d’affichage/de masquage
      6. Champs calculés
    5. FAQ sur la création
  4. Signature d’accords
    1. Signature des accords qui vous ont été envoyés
    2. Outil Remplir et signer
    3. Signature automatique
  5. Gérer les accords
    1. Présentation de la page Gérer
    2. Accords de délégation
    3. Remplacement des destinataires
    4. Limitation de la visibilité des documents
    5. Annulation d’un accord
    6. Création de nouveaux rappels
    7. Vérification des rappels
    8. Annulation d’un rappel
    9. Accès aux flux Power Automate
    10. Autres actions
      1. Fonctionnement de la recherche
      2. Affichage d’un accord
      3. Création d’un modèle à partir d’un accord
      4. Masquage/Affichage des accords dans la vue
      5. Chargement d’un accord signé
      6. Modification des fichiers et des champs d’un accord envoyé
      7. Modification de la méthode d’authentification d’un destinataire
      8. Ajout ou modification d’une date d’expiration
      9. Ajout d’une note à l’accord
      10. Partage d’un accord individuel
      11. Annulation du partage d’un accord
      12. Téléchargement d’un accord individuel
      13. Téléchargement des fichiers individuels d’un accord
      14. Téléchargement du rapport d’audit d’un accord
      15. Téléchargement du contenu des fichiers d’un accord
  6. Rapport d’audit
  7. Rapports et exportations de données
    1. Présentation
    2. Octroi aux utilisateurs d’un accès aux rapports
    3. Graphiques de rapports
      1. Création d’un rapport
      2. Rapports sur les accords
      3. Rapports de transactions
      4. Rapport sur l’activité des paramètres
      5. Modification d’un rapport
    4. Exportations de données
      1. Création d’une exportation de données
      2. Export des données de formulaires web
      3. Modification d’une exportation de données
      4. Actualisation du contenu d’une exportation de données
      5. Téléchargement de l’exportation de données
    5. Attribution d’un nouveau nom à un graphique/une exportation
    6. Duplication d’un rapport/d’une exportation
    7. Planification d’un rapport/d’une exportation
    8. Suppression d’un rapport/d’une exportation
    9. Vérification de l’utilisation des transactions

Fonctionnalités et workflows d’accord avancés

  1. Formulaires web
    1. Création d’un formulaire web
    2. Modification d’un formulaire web
    3. Désactivation/Activation d’un formulaire web
    4. Masquage/Affichage d’un formulaire web
    5. Recherche de l’URL ou du code de script
    6. Préremplissage des champs de formulaire web avec les paramètres d’URL
    7. Enregistrement d’un formulaire web à remplir ultérieurement
    8. Redimensionnement d’un formulaire web
  2. Modèles réutilisables (modèles de bibliothèque)
    1. Formulaires de l’administration américaine dans la bibliothèque Acrobat Sign
    2. Création d’un modèle de bibliothèque
    3. Modification du nom d’un modèle de bibliothèque
    4. Modification du type d’un modèle de bibliothèque
    5. Modification du niveau d’autorisation d’un modèle de bibliothèque
    6. Copie, modification et enregistrement d’un modèle partagé
    7. Téléchargement des données de champ agrégées d’un modèle de bibliothèque
  3. Transfert de la propriété des formulaires web et des modèles de bibliothèque
  4. Workflows Power Automate
    1. Présentation de l’intégration Power Automate et des droits inclus
    2. Activation de l’intégration Power Automate
    3. Actions contextuelles sur la page Gérer
    4. Suivi de l’utilisation de Power Automate
    5. Création d’un flux (exemples)
    6. Déclencheurs utilisés pour les flux
    7. Importation de flux depuis l’extérieur d’Acrobat Sign
    8. Gestion des flux
    9. Modification des flux
    10. Partage des flux
    11. Désactivation ou activation des flux
    12. Suppression des flux
    13. Modèles utiles
      1. Administrateur uniquement
        1. Enregistrement de tous les documents terminés dans SharePoint
        2. Enregistrement de tous les documents terminés dans OneDrive Entreprise
        3. Enregistrement de tous les documents terminés dans Google Drive
        4. Enregistrement de tous les documents terminés dans Dropbox
        5. Enregistrement de tous les documents terminés dans Box
      2. Archivage des accords
        1. Enregistrement des documents terminés dans SharePoint
        2. Enregistrement des documents terminés dans OneDrive Entreprise
        3. Enregistrement de vos documents terminés dans Google Drive
        4. Enregistrement de vos documents terminés dans Dropbox
        5. Enregistrement des documents terminés dans Box
      3. Archivage des accords de formulaire web
        1. Enregistrement des documents de formulaire web terminés dans une bibliothèque SharePoint
        2. Enregistrement des documents de formulaire web terminés dans OneDrive Entreprise
        3. Enregistrement des documents terminés dans Google Drive
        4. Enregistrement des documents de formulaire web terminés dans Box
      4. Extraction des données d’accord
        1. Extraction des données des champs de formulaire de votre document signé et mise à jour de la feuille Excel
      5. Notifications d’accord
        1. Envoi de notifications personnalisées par e-mail avec le contenu de votre accord et l’accord signé
        2. Obtention des notifications Adobe Acrobat Sign dans un canal Teams
        3. Obtention des notifications Adobe Acrobat Sign dans Slack
        4. Obtention des notifications Adobe Acrobat Sign dans Webex
      6. Génération d’un accord
        1. Génération d’un document à partir d’un formulaire Power Apps et d’un modèle Word et envoi pour signature
        2. Génération d’un accord à partir d’un modèle Word dans OneDrive et obtention d’une signature
        3. Génération d’un accord pour la ligne Excel sélectionnée, envoi pour révision et signature
  5. Workflows d’envoi personnalisés
    1. Présentation des workflows d’envoi personnalisés
    2. Création d’un nouveau workflow d’envoi
    3. Modification d’un workflow d’envoi
    4. Activation ou désactivation d’un workflow d’envoi
    5. Envoi d’un accord avec un workflow d’envoi
  6. Partage d’utilisateurs et d’accords
    1. Partage d’un utilisateur
    2. Partage d’accords

Intégration à d’autres produits

  1.  Présentation des intégrations Acrobat Sign
  2.  Acrobat Sign pour Saleforce
  3. Acrobat Sign pour Microsoft
    1. Acrobat Sign pour Microsoft 365
    2. Acrobat Sign pour Outlook
    3. Acrobat Sign pour Word/PowerPoint
    4. Acrobat Sign pour Teams
    5. Acrobat Sign pour Microsoft PowerApps et Power Automate
    6. Connecteur Acrobat Sign pour Microsoft Search
    7. Acrobat Sign pour Microsoft Dynamics
    8. Acrobat Sign pour Microsoft SharePoint
  4. Autres intégrations
    1.  Acrobat Sign pour ServiceNow
    2. Acrobat Sign pour les RH ServiceNow
    3. Acrobat Sign pour SAP SuccessFactors
    4.  Acrobat Sign pour Workday
    5. Acrobat Sign pour NetSuite
    6. Acrobat Sign pour VeevaVault
    7. Acrobat Sign pour Coupa BSM Suite
  5. Intégrations gérées par des partenaires
  6. Obtention d’une clé d’intégration

Développeur Acrobat Sign

  1. API REST
    1. Documentation sur les méthodes
    2. Guide du développeur/SDK
    3. FAQ sur les API
  2. Webhooks
    1. Présentation des webhooks
    2. Configuration d’un nouveau webhook
    3. Affichage ou modification d’un webhook
    4. Désactivation ou réactivation d’un webhook
    5. Suppression d’un webhook
    6. Certificats SSL bidirectionnels
    7. Webhooks dans l’API

Assistance et dépannage

  1. Ressources pour le Service clientèle 
  2. Ressources pour le succès client de grands comptes

L’accès aux API est réservé exclusivement aux comptes de niveau entreprise et développeur.

Liens vers la documentation de base

Liens utiles pour l’API REST 6 :

Remarque :

la prise en charge des API SOAP héritées a pris fin en mai 2021.

Tous les clients qui utilisent l’API SOAP doivent migrer vers l’API REST le plus tôt possible.

Une fois la connexion établie, accédez à Compte > API Acrobat Sign > Informations sur l’API > Documentation de l’API REST.

Se connecter à Acrobat Sign


Concepts généraux

Il est impossible de créer un document en affichant la page dans l’interface utilisateur Web, de faire des glisser/déposer, ou encore d’affecter des rôles de signataire à l’aide de transientDocumentId via l’API.

L’appel transientDocuments renvoie l’ID transientDocumentID, qui est valide pendant 7 jours.  Vous pouvez l’utiliser uniquement pour les autres appels d’API. Il est stocké sur le serveur d’API et cet ID lui est attribué. Téléchargez un fichier, puis indiquez son ID dans les autres appels d’API.

Il est impossible de télécharger directement un document dans Accord à l’aide de l’API REST.

Conformément à l’exigence REST, commencez par créer un document temporaire, puis utilisez cet ID dans les méthodes Accord, Widget ou Bibliothèque comme source du fichier.

Le document temporaire est un fichier source brut tel que .pdf, .doc, .docx, chargé sur les serveurs d’Adobe. Il constitue un moyen pratique de transmettre votre document de base aux serveurs d’API, ou encore un document temporaire sur le Web.

Oui, vous pouvez publier des accords à l’aide de workflows dans la v6, à l’aide d’un appel d’API POST /agreements. Passez le paramètre workflowId dans l’appel d’API.

Vous pouvez obtenir le paramètre workflowId d’un workflow à l’aide de l’appel GET /workflows.

  1. Connectez-vous à Adobe Sign en tant qu’administrateur

  2. Accédez à Compte > API Adobe Sign > Journal de requêtes d’API

    Journaux d’API

  1.  Connectez-vous à Adobe Sign en tant qu’administrateur de compte

  2. Accédez à Compte > API Adobe Sign > Informations sur l’API

  3. Cliquez sur le lien Exemples d’API REST.

    Remarque :

    Pour télécharger le SDK JavaScript, voir https://github.com/adobe-sign/AdobeSignJsSdk.

À partir de la version 6, l’option sendTroughWeb n’est plus disponible. Elle est remplacée par l’état. Il s’agit de l’état de l’accord. Le champ d’état peut uniquement être fourni dans les appels POST. Il n’est jamais renvoyé dans GET /agreements/{ID} et est ignoré s’il est fourni dans l’appel PUT /agreements/{ID}. L’état final de l’accord peut être obtenu à partir de GET /agreements/ID.

state(string) = ['CRÉATION' ou 'BROUILLON' ou 'EN_COURS'].

CRÉATION permet à un utilisateur de créer les documents d’un accord avant de les envoyer. L’opération de création fait ici référence à la création, à la modification ou au placement de champs de formulaire avec leurs configurations (cessionnaire, conditions, type de données, etc.) dans les documents de l’accord. Une fois publié à l’état Création, le document est visible dans la section Brouillon de l’onglet Gérer dans Adobe Sign.

BROUILLON correspond à une étape temporaire ou primitive de la ressource finale prévue. Le brouillon peut être modifié par étapes pour créer la ressource finale. Il n’est pas visible dans la section Brouillon de l’onglet Gérer dans Adobe Sign. Avec l’état Brouillon, les informations sur les participants ne sont pas obligatoires et peuvent être attribuées ultérieurement avec l’option PUT /agreements/agreementId permettant de finaliser le brouillon. Cette étape peut être répétée plusieurs fois jusqu’à ce que vous disposiez de toutes les données requises pour créer l’accord.

EN_COURS modifie le statut de l’accord en Émis pour signature. Ce dernier s’affiche dans la section Émis pour signature de l’onglet Gérer dans Adobe Sign.

La fonction sendThroughWeb permet d’envoyer l’accord de manière interactive. Les différents paramètres du champ Options de la requête v5 POST /agreements permettent à l’utilisateur de configurer cette vue interactive (page Envoyer). L’ensemble de ces paramètres de configuration de page, tels que fileUploadOptions, sont déplacés vers l’API POST /agreements/ID/views.

On obtient ainsi sendThroughWeb en créant un accord à l’état CRÉATION via l’API POST /agreements. Ensuite, pour demander l’URL de la page suivante dans la configuration souhaitée, appelez l’API POST /agreements/ID/views.

Procédez comme suit :

1. Accédez à la documentation de l’API REST v6 et sélectionnez la méthode POST /agreements.
2. Utilisez le code de requête suivant :

{

  "fileInfos": [

    {

      "transientDocumentId": "***************************"

    }

  ],

  "name": "test",

  "participantSetsInfo": [

    {

      "memberInfos": [

        {

          "email": "abc@gmail.com"

        }

      ],

      "order": 1,

      "role": "SIGNATAIRE"

    }

  ],

  "signatureType": "ESIGN",

  "state": "CRÉATION"

}

 

3. À présent, utilisez la méthode POST /agreements/{agreementId}/views avec le code de requête ci-dessous :

 

{

  "name": "CRÉATION"

}

Le code de réponse fournit l’URL des champs de création.

Vous pouvez définir l’URL de rappel de la façon suivante :

  • Utilisez le paramètre ci-dessous pour définir l’URL de rappel selon vos besoins :

    "callbackInfo": "",
  • Contactez le support Adobe Sign pour définir l’URL de rappel par défaut pour le compte complet.

L’interface utilisateur SOAP (SmartBear) reçoit une erreur de connexion SSL similaire à la suivante, obtenue lorsque vous appelez l’API. Cette erreur se produit généralement si vous utilisez un protocole SSL ou TLS obsolète antérieur à TLS1.2

ERREUR : Exception dans la requête : javax.net.ssl.SSLException : Alerte fatale reçue : protocol_version
ERREUR : Une erreur s’est produite [Alerte fatale reçue : protocol_version], voir le journal d’erreurs pour plus d’informations

  1. Ajoutez (-Dsoapui.https.protocols=SSLv3,TLSv1.2) dans le fichier VMOPTIONS du dossier Bin.

  2. Accédez à C:\Program Files\SmartBear\SoapUI-5.2.1\bin (selon l’emplacement où vous avez installé l’interface utilisateur SOAP. Cette dernière peut se trouver sous C:\Program Files (x86))

  3. Dans le fichier VMOPTIONS, activez l’autorisation de lecture/écriture complète.

    VMOPTIONS

  4. Cliquez avec le bouton droit de la souris sur Fichier VMOPTIONS > Propriétés > Onglet Sécurité > Sélectionner un utilisateur > Modifier. (L’icône Contrôle d’accès utilisateur s’affiche sur le bouton Modifier) >Activez toutes les cases à cocher et cliquez sur OK.

  5. Répétez la même procédure pour les administrateurs, les systèmes et tous les packages d’application.

  6. Ouvrez le fichier à l’aide du Bloc-notes.

  7. Ajoutez ce protocole en bas de l’écran : -Dsoapui.https.protocols=SSLv3,TLSv1.2 et enregistrez les modifications.

  8. Fermez l’interface utilisateur SOAP et relancez-la. Aucune erreur SSL ne s’affiche lorsque vous appelez l’API. (Effectuez un test d'appel ping pour vérifier).

Voici les étapes à suivre pour créer un ID client et un secret client dans l’application Adobe Sign :

  1. Connectez-vous au compte Adobe Sign.

  2. Accédez à Compte > API Adobe Sign > Applications API.

    Fnord.

  3. Pour créer une application, cliquez sur l’icône +.

    Fnord.

  4. Saisissez un Nom et un Nom d’affichage.

  5. Sous Domaine, sélectionnez CLIENT, puis cliquez sur Enregistrer.

    Fnord.

  6. Sélectionnez l’application d’un simple clic.

  7. Cliquez sur Configurer OAuth pour l’application.

    Fnord.

  8. Entrez l’URI de redirection.

  9. Pour activer les portées requises, cochez les cases correspondantes, puis cliquez sur Enregistrer.

  1. Connectez-vous à Adobe Sign en tant qu’administrateur de compte

  2. Accédez à Compte > API Adobe Sign > Informations sur l’API

  3. Cliquez sur le lien Clé d’intégration

    Accédez à la clé d’intégration

    Remarque :

    si vous ne voyez pas le lien Clé d’intégration, contactez votre responsable du succès client pour qu’il active votre compte.

    • Nommez la clé selon une valeur intuitive
    • Sélectionnez les différentes portées requises pour votre fonction d’application
    • Une fois la clé configurée, cliquez sur Enregistrer
    Interface Créer une clé d’intégration

  5. Une fois enregistrée, la clé se trouve dans : Compte > Préférences personnelles > Jetons d’accès

    Le nom de la clé et toutes les portées activées sont répertoriés.  

    Cliquez une fois sur la description de la clé pour afficher les liens d’action :

    • Clé d’intégration : ce lien fournit la clé littérale 
    • Révoquer : cette action révoque et supprime définitivement le jeton d’accès
    Jetons d’accès - Clé d’intégration

  1. Connectez-vous au compte Adobe Sign.

  2. Accédez à Compte > API Adobe Sign > Applications de l’API.

  3. Cliquez sur l’icône + pour créer une application.

    Postman1

  4. Cliquez sur Configurer OAuth pour l’application.

    Fnord.

  5. Générez un code d’autorisation à l’aide du lien suivant. L’ID client, l’URI de redirection et les portées doivent être les mêmes que dans l’URL suivante sélectionnée dans l’application. Évitez les espaces dans l’URL suivante. Le shard de type « NA1 » est conforme au compte Adobe Sign associé :

    https://secure.na1.echosign.com/public/oauth?redirect_uri=https://www.google.co.in&response_type=code&client_id=CBJCHBCAABAAo9FZgq31_5BVG_kcIXEe6gNtn-R-gdNe&scope=user_login:self+agreement_send:account

  6. Si l’appel aboutit, sélectionnez le code d’autorisation dans la barre d’adresse.

    Fnord.

  7. Téléchargez et installez Postman à partir du lien https://www.getpostman.com/apps.

  8. Une fois téléchargé et installé, cliquez sur NOUVEAU pour créer un POST.

  9. Entrez le lien https://secure.na1.echosign.com/oauth/token associé à votre compte Adobe Sign.

  10. Sous En-têtes, entrez Content-Type as application/x-www-form-urlencoded.

  11. Assurez-vous que x-www-form-urlencoded est sélectionné dans Corps. Entrez les paramètres ci-dessous avec leurs valeurs correspondantes de l’application créée dans le compte Adobe Sign, puis cliquez sur ENVOYER.

    Fnord.

  12. Si toutes les informations sont correctes, elles renvoient le jeton d’accès et le jeton d’actualisation dans la réponse :

    Fnord.

Lors de l’exécution du processus OAuth, assurez-vous de suivre les points ci-dessous :

1. L’ID client et l’URI de redirection corrects sont spécifiés.
2. Les portées fournies dans l’URL d’autorisation doivent correspondre exactement aux portées fournies dans l’application Adobe Sign.
3. Utilisez le shard correct (na1, na2, au1, eu1, jp1) en fonction du compte configuré.
4. Supprimez tous les espaces dans l’URL d’autorisation (le cas échéant).
5. Vérifiez la syntaxe de l’URL d’autorisation :

https://secure.na1.echosign.com/public/oauth?redirect_uri=https://secure.na1.echosign.com/public/oauthDemo&
response_type=code&client_id=9MEJXY4Y4R7L2T&scope=agreement_send

Les jetons d’accès ne sont valides que pendant 3 600 secondes (une heure), après quoi ils expirent.

Le détenteur de la requête d’API peut utiliser des jetons d’actualisation afin de générer de nouveaux jetons d’accès selon les besoins.

Les webhooks sont pris en charge dans l’API REST v6 et versions ultérieures.

Si un récepteur Webhook ne répond pas dans les 72 heures, le webhook est désactivé et aucune notification n’est envoyée.

Si l’URL cible du webhook ne fonctionne pas pour une raison quelconque, Adobe Sign met en file d’attente le fichier JSON et tente à nouveau la transmission par cycles progressifs durant 72 heures.

Les événements non distribués sont conservés dans une file d’attente pour de nouvelles tentatives. Au cours des 72 heures, les notifications sont remises dans l’ordre dans lequel elles se sont produites, autant que faire se peut.

La stratégie visant à retenter la remise des notifications consiste à doubler le temps entre les tentatives, depuis 1 minute jusqu’à 12 heures, soit 15 tentatives en l’espace de 72 heures.

 

Pour créer un webhook directement à partir de l’interface utilisateur Adobe Sign, commencez par créer une URL webhook via les applications de fonction Azure AD en procédant comme suit :

  1. Connectez-vous via le compte Microsoft https://portal.azure.com/.

  2. Inscrivez-vous aux applications de fonction sous le compte AzureAD.

    Menu Azure

  3. Accédez à AzureAD, puis à Applications de fonction. Cliquez sur l’icône + des Fonctions.

  4. Sélectionnez Webhook+API avec JavaScript comme langage, puis cliquez sur Créer une fonction.

    Interface utilisateur de l’API Azure

  5. Remplacez le fichier Index.js par le fragment de code suivant :

    module.exports = function (context, req) { 
    var clientId = req.headers['x-adobesign-clientid']; 
    // Validate that the incoming ClientID is genuine 
    if (clientId === '************************************') { 
        context.res = { 
            // status: 200, /* Defaults to 200 */ // any 2XX response is acceptable 
            body: { 
                'xAdobeSignClientId' : clientId, 
                 
            }, 
            headers : { 
                'Content-Type' : 'application/json' 
            } 
        }; 
    } 
    else { 
        context.res = { 
            status: 400, 
            body: "Opps!! Illegitimate Call identified" 
        }; 
    } 
    context.done(); 
};

  6. Cliquez sur le bouton Tester dans le coin droit et indiquez l’en-tête suivant :

    X-AdobeSign-ClientId as ***********************

    Test de l’API

  7. Cliquez sur Enregistrer et exécuter.

  8. Une fois que vous avez reçu 200 réponses OK avec l’en-tête suivant, cliquez sur Obtenir l’URL de la fonction

    200 réponses

  9. Copiez l’URL et accédez à l’interface utilisateur d’Adobe Sign > Webhooks. Cliquez sur l’icône + pour procéder à la création.

  10. Entrez les informations suivantes :

    • Nom : il est conseillé d’utiliser un nom intuitif que les autres administrateurs peuvent facilement comprendre.
    • Portée : envergure du webhook. Le compte et le groupe sont disponibles dans l’interface.
      L’API prend en charge les portées Compte, Groupe, Utilisateur et Ressource.
    • Une seule portée par webhook peut être définie
    • URL : URL cible à laquelle Adobe Sign a envoyé la payload JSON.
    • Événements : déclencheurs qui provoquent la création du fichier JSON par Adobe Sign et son envoi à l’URL.
      Chaque événement génère une payload différente en rapport avec l’événement de déclenchement.
      Plusieurs événements peuvent être inclus dans un webhook.
    • Paramètres de notification : les paramètres de notification identifient les sections de la payload JSON de l’événement, ce qui permet de sélectionner uniquement les sections de l’événement qui sont importantes.
    Interface utilisateur Webhook

  11. Une fois le webhook défini, cliquez sur Enregistrer. Le nouveau webhook commence à réagir pour déclencher immédiatement des événements.

L’actif d’accord fait référence à une ressource via laquelle vous pouvez créer un accord, par exemple un document de bibliothèque, un widget et un accord lui-même.

Pour rechercher des événements d’actifs d’accord, commencez par envoyer une requête à l’API qui crée agreementAssetEvents avec les paramètres de recherche pertinents.

La réponse est la première page de résultats avec un paramètre d’ID de recherche et le curseur de la page suivante. Vous pouvez l’utiliser pour récupérer d’autres résultats de page s’ils sont disponibles à l’aide de l’API. Cette dernière récupère agreementAssetEvents en fonction de l’ID de recherche.

  1. Ouvrez la documentation de l’API REST pour la version 5.

  2. Accédez à POST /search/agreementAssetEvents et générez le jeton d’accès avec les portées pertinentes.

  3. Dans le code de la requête, définissez les dates de début et de fin en fonction de la demande :

    { 
  "endDate": "2018-05-22T22:33:33", 
  "startDate": "2017-12-22T22:33:33" 
}

  4. Cliquez sur le bouton Tester. Vous récupérez ainsi les ID d’actifs d’accord, qui peuvent également être utilisés comme ID d’accord.


Gestion des utilisateurs/comptes

  1. Connectez-vous à Adobe Sign.
  2. Accédez à Compte > API Adobe Sign > Documentation de l’API REST.
  3. Sélectionnez la version 5.
  4. Sous la méthode POST /users, utilisez le code de requête mentionné sous la
    méthode UserCreationInfo
    {
    "email": "email@email.com",
    "firstName": "AA",
    "lastName": "AB",
    "password":"12******rte"
    }

Les comptes Adobe Sign qui utilisent Admin Console (Adobe One) pour gérer leurs droits d’accès utilisateur ne peuvent pas utiliser l’API Adobe Sign pour créer des utilisateurs ou gérer des utilisateurs existants.

Adobe One Admin Console utilise une API différente de l’API Adobe Sign. Pour plus d’informations, veuillez consulter les articles suivants :

 

Obtention de l’ID de groupe :

  1. Accédez à  https://secure.na1.echosign.com/public/docs/restapi/v5.

  2. Sous Ressources et opérations, cliquez sur Groupes.

  3. Cliquez sur GET /groups.

  4. Cliquez sur le bouton Jeton d’accès oAuth.

  5. Générez le jeton d’accès.

  6. Cliquez sur le bouton Tester.

    Vous recevez une réponse comme suit avec le nom du groupe et l’ID de groupe :

    { 
  "groupInfoList": [ 
    { 
      "groupId": "3AAABLblqZhB4o9EnlvmGB_m8CrG5O6XClTBO7vmojOOexu5r3G95LtEV2Sp7BuhNvQYSvWB7PmmwVPXnhPIiYSuHV98Cerkp", 
      "groupName": "Default Group" 
    }, 
    { 
      "groupId": "3AAABLblqZhC3dPT6za5h7r1-BOEWivCe_OcAVONhcsKa57SL9_iCwGr5v_JED1No5jE20Pcjv0mYH2J-LoY1AcmqS69vRkO7", 
      "groupName": "test" 
    }, 
  ] 
}

Suppression d’un groupe :

  1. Cliquez sur DELETE /groups/{groupId}.

  2. Pour générer un jeton d’accès, cliquez sur le bouton Jeton d’accès oAuth.

  3. Ajoutez l’ID de groupe reçu dans la réponse de l’appel précédent que vous souhaitez supprimer dans la boîte groupId.

  4. Cliquez sur le bouton Tester.

    Une fois le groupe supprimé, vous recevez une réponse comme suit : Aucun contenu

Remarque :

vous ne pouvez pas supprimer un groupe auquel un utilisateur est affecté. En substance, vous ne pouvez supprimer que le groupe vide. Vous recevez une réponse comme suit s’il existe un utilisateur dans le groupe.


{

  "code": "GROUPE_NON_VIDE",

  "message": "Le groupe ne peut pas être supprimé, car il n’est pas vide."

}


Lancement/envoi d’accords

Génération d’un document temporaire

  1. Accédez à : https://secure.na1.adobesign.com/public/docs/restapi/v6

  2. Cliquez sur transientDocuments et développez la méthode POST /transientDocuments

  3. Cliquez sur le bouton Jeton d’accès oAuth

    Méthode API TransientDocument

    • Activez les portées de la transaction
    • Cliquez sur Autoriser
    Portées OAuth

  5. Autoriser l’accès

    Si vous y êtes invité, cliquez sur Autoriser l’accès

  6. Vous revenez à la page des méthodes de l’API. La valeur Autorisation est maintenant renseignée.

    • Saisissez le nom du fichier dans le champ Nom du fichier
    • Cliquez sur le bouton Choisir un fichier et téléchargez le document de l’accord
    • Cliquez sur le bouton Tester
    Tester

  7. La réponse est générée.

    L’ID transientDocumentID se trouve dans le corps de la réponse :

    ID de document temporaire

Génération d’un accord à l’aide du document temporaire

  1. Accédez à : https://secure.na1.adobesign.com/public/docs/restapi/v6

  2. Cliquez sur accords et développez la méthode POST /agreements

    • Cliquez sur le bouton Jeton d’accès oAuth
    • Activez la portée OAuth
    • Cliquez sur Autoriser
      • Si vous y êtes invité, cliquez sur Autoriser l’accès

  4. Vous revenez à la page des méthodes de l’API. La valeur Autorisation est maintenant renseignée.

    • Copiez le script ci-dessous dans un éditeur de texte (ce script n’est qu’un exemple configuré a minima. Votre code de production sera différent)
    •  Insérez votre valeur trasientDocumentId dans le code à l’endroit indiqué
    { 
  "fileInfos": [ 
   {"transientDocumentId":"COLLER VOTRE VALEUR TRANSIENTDOCUMENTID ICI"} 
  ], 
  "name": "test doc", 
  "participantSetsInfo": [ 
    { 
      "memberInfos": [ 
        { 
          "email": "noreply@echosign.com" 
        } 
      ], 
      "order": 1, 
      "role": "SIGNATAIRE" 
    } 
  ], 
  "signatureType": "ESIGN", 
  "state": "BROUILLON" 
}

     

    • Copiez votre script personnalisé et collez-le dans le champ Infos sur l’accord
    • Cliquez sur le bouton Tester
    Méthode POST /agreements

  5. La réponse est générée.

    L’ID agreementID se trouve dans le corps de la réponse :

    Réponse de la méthode POST /agreements

Voici les étapes à suivre pour ajouter des fichiers dans le paramètre FileInfo :

  1. Utiliser un ID temporaire :

    Accédez à POST /transientDocuments et chargez le document à utiliser à partir de votre système local.
    Utilisez l’ID temporaire généré sous la section Infos sur le fichier de POST /agreements :

    "fileInfos": [ 
     { 
       "transientDocumentId": "" 
     } 
   ],

  2. Utiliser l’ID du document de bibliothèque :

    Accédez au Tableau de bord. Cliquez sur Ajouter un document à la bibliothèque et enregistrez le modèle.
    Dans la documentation de l’API REST, cliquez sur GET /libraryDocuments et récupérez l’ID de bibliothèque pour le modèle en cours de création.
    Sous POST /agreements, indiquez l’ID du document de bibliothèque :

    "libraryDocumentId": "", 
  "libraryDocumentName": "",

  3. Utiliser l’URL publique disponible :

    Fournissez l’URL accessible au public à utiliser sous le paramètre FileInfo :

    { 
      "documentURL": { 
        "mimeType": "", 
        "name": "", 
        "url": "" 
      },

  1. Accédez à https://secure.na1.adobesign.com/public/docs/restapi/v6.

  2. Sélectionnez l’option Accords > POST /agreements. 

  3. Sélectionnez l’option Jeton d’accès Oauth et fournissez les portées nécessaires.

  4. Une fois le jeton d’accès ajouté, vous pouvez utiliser le code de requête suivant :

    { 
"documentCreationInfo": { 
     "recipientSetInfos": [ 
          { 
               "recipientSetRole": "SIGNATAIRE", 
               "recipientSetMemberInfos": [{"email": "testemail@email.com"}] 
          }, 
          { 
               "recipientSetRole": "SIGNATAIRE", 
               "recipientSetMemberInfos": [{"email": "testemail@email.com"}] 
          } 
     ], 
     "signatureFlow": "SÉQUENTIEL", 
     "name": "femme", 
     "signatureType": "ESIGN", 
     "fileInfos": [ 
{ 
"transientDocumentId": "(SAMPLE VALUE)3AAABLblqZhAJ9H6e23kZAfBUbItPvIhHTEyA6eZhziEp4KSntYcULpo43OEXwuWiWa-IM1r1EExYW0044CjCkliP4WFL5yKBUDq5DYSmSxVlFypcD0at8kK-BX-Mu3T9c_3GUqgDg0ArX0MmzWT72GLR_0M4Jq--mtuqGzq-VK1s-WGR6GcbedVY7XWAf3b3h-SpE08Hc-iF3zO7jQzi9newXSl-iW2JJsb_55tggkyxkXAkj74C1WD6KkJzgblK0JU-seh6QPDd0Fv6_mfQe2EPQA31nXj50aXwD_xlUBq7mg5FeaBnZ5bzgoqIWGHkbyeD2taaFdw*"} 
] 
} 
}

Dans l’appel POST /agreements, pour le paramètre signatureflow, vous pouvez passer la valeur SENDER_SIGNS_FIRST ou SENDER_SIGNS_LAST pour ajouter l’expéditeur en tant que premier ou dernier signataire respectivement.

Voici un exemple d’appel au format JSON :

{

  "documentCreationInfo": {

    "fileInfos": [

      {        "transientDocumentId":"3AAABLblqZ-yourIDGoesHere"

      }

    ],

    "name": "Test",

    "recipientSetInfos": [

      {

        "recipientSetMemberInfos": [

          {

            "email": "test@email.com"

          }

        ],

        "recipientSetRole": "SIGNATAIRE"

      }

    ],

    "signatureType": "ESIGN",

    "signatureFlow": "LE_SIGNATAIRE_SIGNE_EN_PREMIER"

  }

}

Remarque :

l’option Envoyer au nom de est disponible uniquement dans l’API REST v6 avec le partage avancé activé.

Si l’autorisation d’envoi n’est pas fournie dans le partage ou si l’option Partage avancé n’est pas activée, vous obtenez une réponse telle que :

 

{"code":"AUTORISATION_REFUSÉE","message":"L'utilisateur indiqué dans l’en-tête x-au-nom-de-utilisateur ne dispose pas des autorisations requise pour effectuer cette opération."}

 

Pour la fonction Envoyer au nom de, activez le partage de compte avancé pour le compte, afin que les utilisateurs puissent donner des autorisations d’envoi à d’autres utilisateurs lors du partage de leur compte. Pour le partage avancé, voir Activation de la fonctionnalité Partage de compte avancé.

Une fois le partage utilisateur activé, suivez les étapes ci-après pour « envoyer au nom de » :

Génération d’un document temporaire :

  1. Accédez à https://secure.adobesign.com/public/docs/restapi/v6.

  2. Sous transientDocuments, cliquez sur POST /transientDocuments.

  3. Pour générer un jeton d’autorisation, cliquez sur le bouton JETON D’ACCÈS OAUTH.

  4. Dans x-au-nom-de-utilisateur, fournissez l’adresse e-mail de l’utilisateur pour lequel vous souhaitez envoyer des messages « au nom de » au format suivant : email:test@email.com

  5. Pour sélectionner un fichier, cliquez sur Choisir un fichier, puis sur Tester.

    Vous recevez une réponse telle que la suivante avec transientDocumentId :

    {"transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*"}

Génération d’un accord à l’aide du document temporaire :

  1. Sous accords, cliquez sur POST /agreements.

  2. Pour générer un jeton d’autorisation, cliquez sur le bouton JETON D’ACCÈS OAUTH.

  3. Dans x-au-nom-de-utilisateur, fournissez l’adresse e-mail de l’utilisateur comme vous l’avez fait lors de la création du document temporaire.

  4. Dans Infos sur l’accord, ajoutez le code suivant, puis cliquez sur Tester.

    { 
  "fileInfos": [ 
    {    "transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*" 
    } 
  ], 
  "name": "Test", 
  "participantSetsInfo": [ 
    { 
      "memberInfos": [ 
        { 
          "email": "signer@email.com" 
        } 
      ], 
      "order": 1, 
      "role": "SIGNATAIRE" 
    } 
  ], 
  "signatureType": "ESIGN", 
  "state": "EN_COURS" 
}

     

    Vous recevez une réponse telle que la suivante avec agreementId :

    { 
  
  "id": "CBJCHBCAABAAUlen3l_fzlj1Kbn_wGZAhYcIgN0J7Qtq" 
  
}

  1. Connectez-vous à Adobe Sign.

  2. Accédez à Compte > API Adobe Sign > Informations sur l’API et cliquez sur Documentation sur les méthodes API REST.

    Interface utilisateur Webhook

  3. Accédez à POST /transientDocuments, chargez un fichier et créez un ID de document temporaire.

  4. Copiez l’ID de document temporaire et utilisez-le dans la méthode POST /agreements. Copiez la requête JSON suivante dans la boîte :

    { 
    "documentCreationInfo": { 
        "mergeFieldInfo": null, 
        "recipientSetInfos": [{ 
                "signingOrder": null, 
                "recipientSetRole": "SIGNATAIRE", 
                "recipientSetMemberInfos": [{ 
                    "securityOptions": null, 
                    "email": "test1@gmail.com" 
                }], 
                "privateMessage": "Bonjour 1", 
                "securityOptions": null 
            }, 
            { 
                "signingOrder": null, 
                "recipientSetRole": "SIGNATAIRE", 
                "recipientSetMemberInfos": [{ 
                    "securityOptions": null, 
                    "email": "test2@gmail.com" 
                }], 
                "privateMessage": "Bonjour 2", 
                "securityOptions": null 
            } 
        ], 
        "signatureType": "ESIGN", 
        "callbackInfo": null, 
        "message": "Veuilez consulter et signer ce document.", 
        "locale": "fr_FR", 
        "vaultingInfo": null, 
        "securityOptions": null, 
        "reminderFrequency": null, 
        "ccs": null, 
        "postSignOptions": null, 
        "signatureFlow": "SIGNATURE_EXPÉDITEUR_NON_REQUISE", 
        "daysUntilSigningDeadline": null, 
        "formFieldLayerTemplates": [], 
        "name": "Adobe Sign Agreement", 
        "formFields": null, 
        "fileInfos": [{ 
            "libraryDocumentName": null, 
            "transientDocumentId": "XXXXXXXXXXXX", 
            "documentURL": null, 
            "libraryDocumentId": null 
        }] 
    } 
}

  5. Pour exécuter la requête JSON, cliquez sur le bouton Tester.

    Interface utilisateur Webhook

    Le fichier JSON correct renvoie la réponse avec l’ID d’accord.

    Interface utilisateur Webhook

Voici les paramètres que vous pouvez transmettre dans le code pour définir un mot de passe d’ouverture :

 

{

    "documentCreationInfo":

    [{

        "signatureType": "ESIGN",

               "recipientSetInfos": [{

            "recipientSetMemberInfos": [{                      

                "email": "abc@xyz.com"

            }],

                   

            "recipientSetRole": "SIGNATAIRE"

        }],

               "signatureFlow": "SIGNATURE_EXPÉDITEUR_NON_REQUISE",

                   "fileInfos": [           {               

            "libraryDocumentId": "3AAABLblqZhBsm_vH7TVzU3hRdbtWuvzfTKDvBzaKZTiehjO2eGTk5Rlu02K-0BYn8HBJVFTWOmT_BQlrofPBlrCdjiJ_JI-V"        

        }       ],

               "name": "Mot de passe d’ouverture pour visualiser le document",

               "securityOptions": {        

            "openPassword": "1234",

                     "protectOpen": true   

        }

    }]

}

 

Pour créer un accord à l’aide d’une API ayant l’état CRÉATION, procédez comme suit :

Accédez à Post /agreements et créez un jeton d’accès avec les portées requises.

Utilisez le code de requête comme suit :

 

{

  "fileInfos": [

    {

      "transientDocumentId": "*********************"

    }

  ],

  "name": "A1",

  "participantSetsInfo": [

    {

      "memberInfos": [

        {

          "email": "abc@xyz.com"

        }

      ],

      "order": 1,

      "role": "SIGNATAIRE"

    }

  ],

  "signatureType": "ESIGN",

  "state": "CRÉATION"

}

 

La version 6 comporte un ensemble d’API de création permettant de créer des accords. Dans la version 5, les champs de formulaire sont directement consommés dans l’API POST /agreements. Toutefois, dans la version 6, l’utilisateur peut créer un accord à l’état CRÉATION (état = CRÉATION) par le biais de v6 POST /agreements et utiliser PUT /agreements/ID/formFields ultérieurement à tout moment pour ajouter des champs de formulaire aux documents de cet accord.

Voici les étapes à suivre :

  1. Accédez à la documentation de l’API REST v6 et sélectionnez la méthode POST /agreements.

  2. Utilisez le code de requête suivant :

    { 
  "fileInfos": [ 
    { 
      "transientDocumentId": "***************************" 
    } 
  ], 
  "name": "test", 
  "participantSetsInfo": [ 
    { 
      "memberInfos": [ 
        { 
          "email": "abc@gmail.com" 
        } 
      ], 
      "order": 1, 
      "role": "SIGNATAIRE" 
    } 
  ], 
  "signatureType": "ESIGN", 
  "state": "CRÉATION" 
}

  3. Utilisez la méthode PUT /agreements/{agreementId}/formFields avec la requête suivante comme exemple :

    { 
  "fields": [ 
    { 
     "locations": [ 
          { 
            "height": 36, 
            "left": 75, 
            "pageNumber": "1", 
            "top": 200, 
            "width": 150 
          } 
        ], 
        "contentType": "BLOC_SIGNATURE", 
        "name": "sigBlock1", 
        "inputType": "SIGNATURE", 
        "recipientIndex":1 
       } 
]}

     

    Une fois la requête terminée, l’accord est envoyé au destinataire mentionné.

  1. Connectez-vous à Adobe Sign.

  2. Accédez à Compte > API Adobe Sign > Informations sur l’API et cliquez sur Documentation sur les méthodes API REST.

    Interface utilisateur Webhook

  3. Accédez à POST /transientDocuments, chargez un fichier et créez un ID de document temporaire.

  4. Copiez l’ID de document temporaire et utilisez-le dans la méthode POST /agreements. Copiez la requête JSON suivante dans la boîte :

    { 
    "documentCreationInfo": { 
        "recipientSetInfos": [{ 
                "recipientSetRole": "SIGNATAIRE", 
                "recipientSetMemberInfos": [{ 
                    "email": "test1@gmail.com" 
                }], 
                "privateMessage": "Bonjour 1" 
            }, 
            { 
                "recipientSetRole": "SIGNATAIRE", 
                "recipientSetMemberInfos": [{ 
                    "email": "test2@gmail.com" 
                }], 
                "privateMessage": "Bonjour 2" 
            } 
        ], 
        "signatureType": "ESIGN", 
        "message": "Veuillez consulter et signer ce document.", 
        "signatureFlow": "SIGNATURE_EXPÉDITEUR_NON_REQUISE", 
        "name": "Démo1", 
        "fileInfos": [{ 
            "transientDocumentId": "XXXXXXXXXX" 
        }], 
        "formFields": [{ 
                "hidden": "1", 
                "defaultValue": "test1@gmail.com", 
                "name": "E-mail du signataire (Candidat-1)", 
                "inputType": "CHAMP_TEXTE", 
                "readOnly": true, 
                "locations": { 
                    "pageNumber": 1, 
                    "top": 100, 
                    "left": 100, 
                    "width": 100, 
                    "height": 30 
                }, 
  
                "contentType": "EMAIL_SIGNATAIRE" 
            }, 
            { 
                "name": "Signature (Candidat-2)", 
                "inputType": "SIGNATURE", 
                "locations": { 
                    "pageNumber": 1, 
                    "top": 520, 
                    "left": 162, 
                    "width": 280, 
                    "height": 30 
                }, 
                "contentType": "SIGNATURE", 
                "required": 1, 
                "recipientIndex": 1 
            }, 
            { 
                "name": "Signature (Candidat-3)", 
                "inputType": "SIGNATURE", 
                "locations": { 
                    "pageNumber": 2, 
                    "top": 312, 
                    "left": 154, 
                    "width": 280, 
                    "height": 30 
                }, 
                "contentType": "SIGNATURE", 
                "required": 1, 
                "recipientIndex": 1 
            }, 
            { 
                "defaultValue": "017/09/2018", 
                "displayFormatType": "DATE", 
                "name": "Date de signature (Candidat-4)", 
                "format": "DATE_JJ_MM_AAAA", 
                "inputType": "CHAMP_TEXTE", 
                "readOnly": true, 
                "locations": { 
                    "pageNumber": 2, 
                    "top": 260, 
                    "left": 90, 
                    "width": 80, 
                    "height": 30 
                }, 
                "contentType": "DONNÉES", 
                "required": 1, 
                "recipientIndex": 1 
            }, 
            { 
                "name": "Signature (Candidat-5)", 
                "inputType": "SIGNATURE", 
                "locations": { 
                    "pageNumber": 3, 
                    "top": 199, 
                    "left": 179, 
                    "width": 276, 
                    "height": 30 
                }, 
                "contentType ": "SIGNATURE", 
                "required": 1, 
                "recipientIndex": 1 
            }, 
            { 
                "contentType": "DATE_SIGNATURE", 
                "defaultValue": "06/07/2018", 
                "displayFormatType": "DATE", 
                "name": "Date de signature (Candidat-6)", 
                "format": "DATE_JJ_MM_AAAA", 
                "inputType": "CHAMP_TEXTE", 
                "readOnly": true, 
                "locations": { 
                    "pageNumber": 3, 
                    "top": 188, 
                    "left": 488, 
                    "width": 76, 
                    "height": 25 
                }, 
                "required": 1, 
                "recipientIndex": 1 
            }, 
            { 
                "name": "Signature (Candidat-7)", 
                "inputType": "SIGNATURE", 
                "locations": { 
                    "pageNumber": 3, 
                    "top": 370, 
                    "left": 37, 
                    "width": 210, 
                    "height": 26 
                }, 
                "contentType ": "SIGNATURE", 
                "required": 1, 
                "recipientIndex": 2 
            }, 
            { 
                "contentType ": "DATE_SIGNATURE", 
                "defaultValue": "01/02/2018", 
                "name": "Date de signature (Candidat-8)", 
                "locations": { 
                    "pageNumber": 3, 
                    "top": 370, 
                    "left": 300, 
                    "width": 76, 
                    "height": 26 
                }, 
                "required": 1, 
                "recipientIndex": 2 
  
            } 
        ] 
    } 
}

  5. Pour exécuter la requête JSON, cliquez sur le bouton Tester.

    Interface utilisateur Webhook

    Le fichier JSON correct renvoie la réponse avec l’ID d’accord.

    Interface utilisateur Webhook

  1. Connectez-vous à Adobe Sign.

  2. Accédez à Compte > API Adobe Sign > Informations sur l’API et cliquez sur Documentation sur les méthodes API REST.

    Fnord.

  3. Accédez à POST /transientDocuments, chargez un fichier et créez un ID de document temporaire.

  4. Copiez l’ID de document temporaire et utilisez-le dans la méthode POST /agreements. Copiez la requête JSON suivante dans la boîte :

    { 
    "options": { 
        "noChrome": true, 
        "authoringRequested": true 
    }, 
    "documentCreationInfo": { 
        "recipientSetInfos": [{ 
                "recipientSetRole": "SIGNATAIRE", 
                "recipientSetMemberInfos": [{ 
                    "email": "test1@gmail.com" 
                }], 
                "privateMessage": "Bonjour 1" 
            }, 
            { 
                "recipientSetRole": "SIGNATAIRE", 
                "recipientSetMemberInfos": [{ 
                    "email": "test2@gmail.com" 
                }], 
                "privateMessage": "Bonjour 44" 
            } 
        ], 
        "signatureType": "ESIGN", 
        "message": "Veuillez consulter et signer ce document.", 
        "locale": "fr_FR", 
        "signatureFlow": "SIGNATURE_EXPÉDITEUR_NON_REQUISE", 
        "formFieldLayerTemplates": [], 
        "name": "Adobe Sign Agreement", 
        "formFields": null, 
        "fileInfos": [{ 
            "libraryDocumentName": null, 
            "transientDocumentId": "XXXXXXXXXXXX" 
        }] 
    } 
}

  5. Pour exécuter la requête JSON, cliquez sur le bouton Tester.

    Fnord.

    Le fichier JSON correct renvoie la réponse avec l’ID d’accord.

    Fnord.

  6. Pour ouvrir l’accord en mode de création, copiez l’URL et collez-la dans la barre d’adresse d’un navigateur.

  7. Glissez-déposez les champs de formulaire à l’emplacement requis.

  8. Pour envoyer l’accord pour signature, cliquez sur Envoyer. 

Utilisez POST /agreements pour créer un accord. L’accord est envoyé pour signature et l’ID d’accord est renvoyé dans la réponse au client. Voici le format JSON permettant d’envoyer un accord à l’aide de la méthode d’authentification par téléphone.

 

{

"documentCreationInfo": {

"mergeFieldInfo": null,

"recipientSetInfos": [{

"signingOrder": null,

"recipientSetRole": "SIGNATAIRE",

"recipientSetMemberInfos": [{

"securityOptions": null,

"email": "Signer@email.com"

}],

 

"privateMessage": null,

"securityOptions": [{

"authenticationMethod": "TÉLÉPHONE",

"phoneInfos": [{

"phone": "1111111111",

"countryCode": "+1"

}]

}]

}],

 

"signatureType": "ESIGN",

"callbackInfo": null,

"message": "Veuillez consulter et signer ce document.",

"locale": "fr_FR",

"vaultingInfo": null,

"securityOptions": null,

"reminderFrequency": null,

"ccs": null,

"postSignOptions": null,

"signatureFlow": "SIGNATURE_EXPÉDITEUR_NON_REQUISE",

"daysUntilSigningDeadline": null,

"formFieldLayerTemplates": [],

"name": "Accord Adobe Sign - Test de l'authentication par téléphone",

"formFields": null,

"fileInfos": [{

"libraryDocumentName": null,

"transientDocumentId": "3AAABLYourTransactionID",

"documentURL": null,

"libraryDocumentId": null

}]

},

 

"options": {

"autoLoginUser": true,

"authoringRequested": false,

"noChrome": true,

"sendThroughWeb": null,

"sendThroughWebOptions": null,

"locale": "fr_FR"

}

}

 

Vous pouvez fusionner les données directement dans les champs de formulaire à l’aide des méthodes suivantes :

  • Utilisation d’un modèle de bibliothèque :

    Si vous utilisez un ID de modèle de bibliothèque sous le paramètre FileInfo, assurez-vous de fournir le nom exact du champ et les données associées dans la section ci-dessous :

 

"mergeFieldInfo": [

     {

       "defaultValue": "",

       "fieldName": ""

     }

   ],

 

  • Utilisation de balises de texte dans un document chargé en tant que document temporaire :

    Si vous chargez un document contenant des balises en tant que document temporaire, assurez-vous de fournir le nom exact du champ et les données associées dans la section ci-dessous : 

 

"mergeFieldInfo": [

     {

       "defaultValue": "",

       "fieldName": ""

     }

   ],

 

Comment envoyer un accord à l’aide d’une API dont les valeurs sont préremplies pour les champs de formulaire spécifiques (champ de fusion) ?

La condition préalable de cet appel est d’abord de terminer l’étape Transfert temporaire et d’obtenir un ID transientDocumentId (à l’aide de : secure.na1.echosign.com/public/docs/restapi/v5#!/transientDocuments/createTransientDocument) à utiliser ici.

  • Cet appel inclut la section mergeFieldInfo où les valeurs par défaut pour des champs de formulaire spécifiques sont déjà remplies.
  • Ainsi, les données d’un autre système sont pré-remplies dans l’appel d’API.
  • Ces champs de l’accord sont soit modifiables soit en lecture seule.

 

Conditions préalables :

  1. ID de document temporaire
  2. Noms de champ et leurs valeurs

 

Exemple d’appel de requête :

 

Requête :

POST /api/rest/v5/agreements HTTP/1.1

Hôte : api.na1.echosign.com (vous pouvez également spécifier votre nom de shard, que vous pouvez trouver à l’aide de l’appel getbaseURis : https://secure.na1.echosign.com/public/docs/restapi/v5#!/base_uris/getBaseUris

Access-Token : 2AAABLblqZhA_D1mluNKQP7py5vXtt-1UHl9NR25e_C3LnKTUH14IblbrXODbXGRozyr7ChBkJNM*

x-user-email : sender@yourdomain.com

Content-Type : application/json

Cache-Control : no-cache

 

{

   "documentCreationInfo": {

       "signatureType": "ESIGN",

       "recipientSetInfos": [

           {

               "recipientSetMemberInfos": [

                   {

                       "email": “signerEmail@domain.com"

                   }

               ],

               "recipientSetRole": "SIGNATAIRE"

           }

        ],

      

       "signatureFlow": "SIGNATURE_EXPÉDITEUR_NON_REQUISE",

       "message": "Veuillez signer ce document !",

       "fileInfos": [

           {

               "transientDocumentId": "3AAABLblqZhD1uP3ZnkJximC0JV1S677PR5xmybSJ-SJn6OtEy2tVqFyMN4xUAbhKTSkLw2Zb6HEF4zAGsrUd2ycoB8fFHQJhrci0O6267VztmIL4nCicSqvAjO7HckATHAsovVmuYwI9_FDDgHg0ogyti62L13HQFZIQRe9iyQMvvzbmksM7ODNK_HEepEKRCeJTtis9FOlz6uRCcIMNlbX_2GU8utWT"

           }

       ],

       "name": "MSA modifié”,

        "mergeFieldInfo": [

            {

                "fieldName": "Nom du compte",

                "defaultValue": "Garage de Sam"

            },

            {

                "fieldName": "Numéro du compte",

                "defaultValue": "8756999"

            },

            {

                "fieldName": "Code postal",

                "defaultValue": "94501"

            },

            {

                "fieldName": "Ville",

                "defaultValue": "CityVille"

            },

            {

                "fieldName": "État",

                "defaultValue": "CA"

            },

            {

                "fieldName": "Rue",

                "defaultValue": "123 Some Road"

            },

            {

                "fieldName": "Titre1",

                "defaultValue": "COO"

            },

            {

                "fieldName": "Description",

                "defaultValue": "Nouvelle description ici"

            }

        ]

   }

 

}

 

La réponse à cet appel est un agreementId que vous devez stocker dans votre système pour les appels suivants (signingUrl, status, formData, etc.).

 

Réponse :

{

  "agreementId": "3AAABLblqZhCf_7xDcrOgKFwAabp1S-OFfvUdHf2wJsSMwlB95_x_WdUeab67jOkJi1IJzWuSJ0zdNNKugS1blZB4LT5vNVyJ"

}

 

Lors de l’exécution de la méthode POST /megaSigns/{megaSignId}/views, une erreur s’affiche : « La vue demandée n’est pas disponible pour la ressource à l’état actuel ».

Cette erreur s’affiche si la valeur du paramètre de nom fournie n’est pas valide dans le code de requête ci-dessous :

{
  "name": " "
}

Par exemple, si l’accord Mega Sign est déjà EN_COURS, la valeur CRÉATION renvoie l’erreur mentionnée. Assurez-vous que la valeur fournie est conforme à l’état actuel de l’accord.

Lors de l’exécution de la méthode PUT /megaSigns/{megaSignId}/state, une erreur affiche comme « Aucune valeur fournie pour les informations d’annulation de MegaSign ».

L’erreur est provoquée lorsque le code de requête ne comporte pas le paramètre : 

 "megaSignCancellationInfo": {
    "comment": "",
    "notifyOthers": false
  }

Au lieu d’utiliser le schéma minimal, cliquez sur Schéma de modèle complet et indiquez le code de requête complet pour exécuter l’appel d’API. 

Pour modifier l’état de l’accord MegaSign, utilisez la commande PUT /megaSigns/{megaSignId}/state et procédez comme suit :

  1. Accédez à la documentation de l’API REST v6 et sélectionnez la méthode  
    PUT /megaSigns/{megaSignId}/state.
  2. Fournissez la valeur Autorisation, ainsi que les propriétés If-Match and megasignID.
    • Pour récupérer megasignID, utilisez GET /megaSigns
    • Pour récupérer If-Match, utilisez GET /megaSigns/{megaSignId}, puis, sous en-tête, recherchez la balise ETag
  3. {
      "state": "ANNULÉ",
      "megaSignCancellationInfo": {
       "comment": "annuler",
       "notifyOthers": false
      }
    } 

Pour enregistrer un webhook, l’URL du webhook répond à cette demande de vérification avec un code de réponse 2XX. De plus, elle peut renvoyer la même valeur d’ID client de l’une des deux façons suivantes :

  1. Dans un en-tête de réponse X-AdobeSign-ClientId. Il s’agit du même en-tête, qui est transmis dans la requête et repris dans la réponse.
  2. Dans le corps de la réponse JSON avec la clé X-AdobeSign-ClientId. Sa valeur correspond au même ID client que celui envoyé dans la requête.

Adobe Sign reçoit la réponse 2xx avec X-AdobeSign-ClientId. L’utilisateur peut vérifier si la configuration est correcte dans le webhook.

L’URL du webhook ne répond pas conformément au comportement attendu. Pour chaque notification POST envoyée par Adobe Sign, l’URL répond avec le code d’état 2XX et renvoie l’ID client des en-têtes de requête (X-AdobeSign-ClientId) vers les en-têtes de réponse. 

Pour plus d’informations, cliquez sur le lien suivant :
https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks/webhook_events.md

Lorsque l’URL ne respecte pas ce protocole, Adobe Sign considère qu’elle n’a pas accédé à la requête et tente une reprogrammation, conformément à la politique fiable.

Si le webhook ne répond pas et que le délai ou l’intervalle maximal de nouvelle tentative est dépassé, le webhook est désactivé.

  Les posts Twitter™ et Facebook ne sont pas couverts par les conditions de Creative Co


Gérer/Obtenir des informations sur les accords

Pour modifier le document déjà envoyé pour signature, utilisez la méthode PUT /agreements/{agreementId}, qui permet de mettre à jour un accord existant. Indiquez l’ID temporaire et l’ID d’accord dans le code de requête suivant :

 

{

  "documentUpdateInfo": {

    "fileInfos": [

      {

        "agreementDocumentId": "",

        "transientDocumentId": ""

      }

    ]

  }

}

 

Suivez les instructions ci-après pour mettre à jour l’état de CRÉATION vers EN_COURS à l’aide de PUT /agreements/{agreementId}/state :

  1. Récupérez l’ID d’accord à l’aide de la méthode POST /agreements.

  2. Utilisez GET /agreements/{agreementId} pour récupérer la dernière balise ETag.

  3. Accédez à PUT /agreements/{agreementId}/state et fournissez les informations suivantes : "state": "EN_COURS"

Non.

Il n’existe aucune méthode dans l’API REST actuelle pour télécharger une copie signée.

L’expéditeur doit télécharger la copie signée à partir de la page Gérer.

DELETE /agreements/ID utilisé pour permettre de masquer un accord de la page de gestion.

Adobe propose une nouvelle API PUT /agreements/ID/me/visibility permettant de contrôler la visibilité d’un accord (dans GET /agreements). Outre les fonctionnalités fournies par DELETE /agreements/ID, le nouveau point d’entrée de visibilité permet également à un utilisateur d’inverser l’opération de masquage, c’est-à-dire de rendre l’accord à nouveau visible. 

Vous pouvez également suivre les étapes détaillées ci-dessous :

  1. Accédez à la méthode GET /agreements et récupérez l’ID de l’accord.
  2. Cliquez sur PUT /agreements/{agreementId}/me/visibility et indiquez la requête ci-dessous :
    {
      "visibility": "MASQUER"
    }
    L’ID d’accord n’est masqué que dans GET /libraryDocuments, mais il est toujours visible dans l’interface utilisateur de l’onglet Gérer.
Remarque :

La fonction de rétention de l’API n’est pas activée par défaut.

Pour activer l’opération DELETE /agreements, contactez votre responsable du succès client et demandez que la rétention des API soit activée pour le compte.

Pour plus d’informations sur l’activation des fonctionnalités de rétention pour votre compte, consultez Adobe Sign - Conservation des documents.

  1. Connectez-vous en tant qu’administrateur Adobe Sign et accédez à : https://secure.adobesign.com/public/docs/restapi/v6

    • Cliquez sur accords et développez la méthode GET /agreements
    • Cliquez sur le bouton JETON D’ACCÈS OAUTH
    • Activez la portée agreement_read:self
    • Cliquez sur le bouton Autoriser
      • Si vous y êtes invité, cliquez sur Autoriser l’accès
    • Cliquez sur le bouton Tester !
    Méthode GET /agreements

  3. La réponse est générée.

    L’ID agreementId se trouve dans le corps de la réponse :

    Réponse GET /agreements

  4. DELETE /agreements/{agreementId}/documents : Supprime tous les documents associés à un accord. L’accord lui-même reste visible sur la page Gérer.

    • Sélectionnez l’opération DELETE /agreements à exécuter.
    • Cliquez sur le bouton JETON D’ACCÈS OAUTH et créez un jeton d’accès avec l’étendue agreement_retention.
    • Indiquez l’ID agreementId de l’accord à supprimer.
    • Une fois l’accord supprimé, le corps de la réponse affiche « aucun contenu ».

Si l’opération DELETE /agreements n’est pas activée, vous obtenez la réponse suivante :

 "code": "EXPIRATION_DYNAMIQUE_DU_DOCUMENT_NON_ACTIVÉE",

  "message": « L’opération nécessite l’activation de certains paramètres de compte. Veuillez contacter l’équipe Adobe Sign pour activer ces paramètres. »

Comment télécharger le document signé avec le rapport d’audit et le document d’accompagnement via l’API REST Adobe Sign plutôt que de lancer un appel distinct pour télécharger le rapport d’audit ?

GET /agreements/{agreementId}/auditTrail

  1. Accédez à https://secure.na1.adobesign.com/public/docs/restapi/v5.

  2. Cliquez sur GET /agreements/{agreementId}/combineDocument.

  3. Cliquez sur le bouton Jeton d’accès oAuth.

  4. Le jeton d’accès est généré automatiquement une fois son autorisation acceptée.

  5. Fournissez l’ID agreementId.

  6. Sous attachSupportDocuments, sélectionnez True dans la liste déroulante.

  7. Sous attachAuditReport, sélectionnez True dans la liste déroulante.

  8. Cliquez sur le bouton Tester.

    Obtention de documents combinés

    Téléchargement du PDF combiné du document d’accompagnement signé et du rapport d’audit

Pour télécharger des documents par lot, seul l’outil d’exportation de documents est disponible. L’API ne permet de télécharger que des documents qu’un par un. Voici la méthode via l’API :

https://secure.na1.adobesign.com/public/docs/restapi/v5#!/agreements/getCombinedDocument


Modèles de bibliothèque et formulaires web

  1. Connectez-vous à Adobe Sign en tant qu’administrateur et accédez à https://secure.na1.adobesign.com/public/docs/restapi/v6

    • Cliquez sur libraryDocuments et développez la méthode GET /libraryDocuments
    • Cliquez sur le bouton JETON D’ACCÈS OAUTH
    • Activez la portée library_read:self
    • Cliquez sur le bouton Autoriser
      • Si vous y êtes invité, cliquez sur Autoriser l’accès
    • Cliquez sur le bouton Tester !
    Méthode GET /libraryDocument

  3. La réponse est générée.

    L’ID libraryDocumentId se trouve dans le corps de la réponse :

    Réponse GET /libraryDocument

Adobe propose une nouvelle API PUT /libraryDocuments/ID/me/visibility permettant de contrôler la visibilité d’un accord (dans GET /agreements). Outre les fonctionnalités fournies par DELETE /agreements/ID, le nouveau point d’entrée de visibilité permet également à un utilisateur d’inverser l’opération de masquage, c’est-à-dire de rendre l’accord à nouveau visible.

Vous pouvez suivre les étapes détaillées ci-dessous :

  1. Accédez à la méthode GET /libraryDocuments et récupérez l’ID de l’accord.
  2. Cliquez sur PUT /libraryDocuments/{libraryDocumentId}/me/visibility et indiquez la requête ci-dessous :
    {
      "visibility": "MASQUER"
    }
    L’ID de bibliothèque n’est masqué que dans GET /libraryDocuments, mais il est toujours visible dans l’interface utilisateur de l’onglet Gérer.
Remarque :
  • Soumettez une demande à l’équipe d’assistance pour que la portée soit activée pour la suppression de la bibliothèque.
  • L’API supprime le document de bibliothèque. Toutefois, les accords créés à l’aide de ce document de bibliothèque ne sont pas affectés.


Génération d’un ID libraryDocumentID

  1. Accédez à https://secure.echosign.com/public/docs/restapi/v5.

  2. Cliquez sur libraryDocuments.

  3. Cliquez sur le bouton Jeton d’accès oAuth.

    Autorisez l’accès : Jeton pour soi, un groupe ou un compte.

  4. Sélectionnez libraryTemplateType : Document ou Calque_champ_formulaire.

  5. Cliquez sur le bouton Tester.

    Vous pouvez recevoir une réponse comme suit pour tous vos modèles. (Copiez l’ID libraryDocumentId pour le modèle de bibliothèque que vous souhaitez supprimer).

    { 
  "libraryDocumentList": [ 
    { 
      "name": "champs de test", 
      "modifiedDate": "2017-08-04T01:06:05-07:00", 
      "scope": "PERSONNEL", 
      "libraryDocumentId": "3AAABLblqZhAK53Dvzq88Q1Ov0TEvMAySDPpIVjF1PWgUpy0H1uYggt4iwGiRSZYlWfl9ms_AcmgZ_uZMPPN2hNT9izwaspHc", 
      "libraryTemplateTypes": [ 
        "DOCUMENT" 
      ] 
    },


Suppression de modèles de bibliothèque

  1. Copiez l’ID libraryDocumentID du corps de la réponse.

  2. Accédez à DELETE /libraryDocuments.

  3. Cliquez sur le bouton Jeton d’accès oAuth. Autorisez l’accès : Jeton pour soi, un groupe ou un compte.

  4. Collez l’ID libraryDocumentId dans le champ Valeur.

  5. Cliquez sur le bouton Tester. 
    Le modèle est supprimé.

    Vous obtenez le code de réponse suivant : 204

Remarque :

Seuls les formulaires web ayant l’état Brouillon peuvent être mis à jour.

  1. Créez le widget à l’aide de POST /widgets.

  2. Obtenez l’ID de widget à partir de GET/ widgets.

  3. Une fois la création terminée à l’aide de la méthode GET /widgets/{widgetId}, récupérez l’ETag à partir de l’en-tête Réponse.

    Foo

  4. Sous PUT /widgets/{widgetId}, utilisez la balise ETag de GET /widgets/{widgetId}. Sous le paramètre If-Match, entrez widgetId et widgetInfo.

    Foo 

    { 
  "fileInfos": [ 
    { 
      "transientDocumentId": "******" 
    } 
  ], 
  "name": "Widht_Name", 
  "status": "BROUILLON", 
  "widgetParticipantSetInfo": { 
    "memberInfos": [ 
      { 
        "email": "" 
      } 
    ], 
    "role": "SIGNATAIRE" 
  } 
}


Exemples d’utilisation

  1. Effectuez un appel GET /agreements avec l’utilisateur x-api-user approprié.

  2. Dans le corps de la réponse, recherchez l’accord pour lequel vous souhaitez rechercher l’URL de signature et notez son ID

  3. Effectuez un appel GET /agreements/{agreementId}/signingUrls à l’aide de l’ID d’accord que vous avez reçu de l’appel GET /agreements.

     

    Résultat

    La sortie renvoie l’adresse e-mail du/des signataire(s) et l’URL de signature électronique.

    Méthode GET /agreements

Recevez de l’aide plus rapidement et plus facilement

Nouvel utilisateur ?

Liens rapides

Voir toutes vos formules Gérer vos formules
Afficher les liens rapides
Masquer les liens rapides

Informations juridiques    |    Politique de confidentialité en ligne