API Adobe Acrobat Sign : FAQ

1. Connectez-vous à Acrobat Sign.
2. Accédez à API Acrobat Sign > Documentation sur 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 Acrobat Sign qui utilisent Admin Console (Adobe One) pour gérer leurs droits d’accès utilisateur ne peuvent pas utiliser l’API Acrobat Sign pour créer des utilisateurs ou gérer des utilisateurs existants.

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

• https://helpx.adobe.com/fr/enterprise/help/users.html
• https://developer.adobe.com/umapi/

Obtention de l’ID de groupe :

Suppression d’un groupe :

Génération d’un document temporaire

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

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

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

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"

  }

}

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é, reportez-vous à la section Activation du 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 :

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

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

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 :

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 :

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.

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 :

• 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 : 

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 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 :

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.

Acrobat 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 Acrobat 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://developer.adobe.com/acrobat-sign/docs/overview/developer_guide/#!adobedocs/adobe-sign/master/webhooks/webhook_events.md

Lorsque l’URL ne respecte pas ce protocole, Acrobat 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

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 :

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

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 permettait de masquer un accord dans la page de gestion.

Adobe dispose d’une nouvelle API PUT /agreements/ID/me/Visibility pour 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.

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 Acrobat 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 Acrobat Sign plutôt que de lancer un appel distinct pour télécharger le rapport d’audit ?

GET /agreements/{agreementId}/auditTrail

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

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.

Génération d’un ID libraryDocumentID

Suppression de modèles de bibliothèque