Foire aux questions à l’attention des développeurs DocuSign – SDK Android

Foire aux questions à l’attention des développeurs DocuSign – SDK Android

Vous trouverez ci-dessous des réponses à quelques-unes des questions les plus fréquentes concernant SDK Android et DocuSign. Si vous voulez consultez des foires aux questions destinées aux développeurs sur d’autres rubriques, reportez-vous à Foire aux questions à l’attention des développeurs DocuSign – Table des matières ou utilisez les liens se trouvant sous Références à la fin de cette page.


SDK Android


SDK Android

Pourquoi est-ce que je reçois l’erreur « Jeton d’accès non valide » ?

Lorsque vous générez un jeton d’accès à l’aide de votre Jeton web JSON (JWT), le jeton a une durée de vie d’une heure. Si vous invoquez une méthode SDK utilisée pour la signature après expiration du jeton, le SDK renvoie l’exception « Jeton d’accès non valide ».

Lorsque vous utilisez la méthode login(), assurez-vous que vous respectez la valeur du jeton concernant l’attribut expiresIn. Une fois le nouveau jeton d’accès généré à l’aide du flux Jeton web JSON (octroi JWT), la valeur d’expiration du jeton devrait être correcte pour la méthode login() de SDK. Pour plus de sécurité, utilisez la méthode authenticationDelegate.isSessionActive() de SDK pour tester la validité du jeton d’accès. Si le jeton arrive à expiration, récupérez un autre jeton dans votre back-end et invoquez la méthode login() de SDK avec les nouvelles valeurs accessToken et expiresIn.


Comment puis-je masquer ou contourner l’écran de signature d’hôte au début d’une session de signature ?

Si votre application n’affiche pas les destinataires et l’ordre de signature avant l’hébergement, invoquez la méthode SDK suivante afin de masquer l’écran de signature hôte. Cette méthode ne fonctionne que si les valeurs par défaut de l’enveloppe sont fournies dans les méthodes de signature.

Android_Bypass_Host_Signing.PNG


Nous ne voulons pas que nos utilisateurs qui partagent les identifiants DocuSign de l’organisation utilisent l’intégration. Quelles sont nos options d’authentification ?

Pour éviter une identification ou authentification implicite, utilisez un jeton d’accès :

Android_Access_Token_Login.PNG

Pour obtenir un jeton d’accès, utilisez l’une des méthodes suivantes :

Le flux d’authentification de l’octroi JWT requiert une prise en charge du serveur. Une fois que le serveur aura réalisé l’authentification et récupéré le jeton d’accès, transférez le jeton et la durée d’expiration à votre application, qui invoquera alors la méthode login() référencée plus haut.


Pourquoi est-ce que je reçois une erreur « Fichier introuvable à l’URI indiquée » lors de la création d’une enveloppe à l’aide de DSEnvelope.Builder ?

Lorsque vous créez l’enveloppe à l’aide de la classe DSEnvelope.Builder de SDK Android, vous devez convertir le fichier en URI comme indiqué ci-desosus.

Android_File_Not_Found_1.PNG

Si vous utilisez la classe DSEnvelope.Builder, vous pouvez définir l’URI du document comme suit :

Android_File_Not_Found_2.PNG


Quel est l’espace libre dont mon appareil a besoin pour mettre en cache un modèle en utilisant le SDK Android ?

L’appareil aura besoin d’environ 1 Go d’espace libre pour mettre en cache un modèle, selon la taille du document et le nombre de champs.


Puis-je configurer par programmation des onglets en lecture seule pour un modèle avec le SDK Android ?

Vous pouvez uniquement configurer la propriété Lecture seule pour l’onglet d’un modèle à partir du portail web DocuSign. Depuis le web, lorsque vous placez l’onglet sur le document, les propriétés de l’onglet s’affichent sur la droite de l’IU. Vous pouvez alors sélectionner la propriété Lecture seule pour cet onglet.

Si vous préremplissez les balises et valeurs des onglets lors de la conversion du modèle en enveloppe, les champs concernés seront en lecture seule au moment de la signature. Dans le paramètre tabValueDefaults de la classe DSEnvelopeDefaults, vous pouvez indiquer la balise et la valeur de l’onglet.


Pourquoi la synchronisation de mon enveloppe avec mon sandbox a-t-elle échoué après une signature en mode hors ligne ?

Vérifiez vers quel environnement votre application renvoie.

Si votre application renvoie vers l’environnement de démo, vous pouvez consulter l’enveloppe signée/complétée à cette adresse : https://www.demo.docusign.net.

Si votre application renvoie vers l’environnement de production, vous pouvez consulter l’enveloppe signée/complétée à cette adresse : https://www.docusign.net.


Pourquoi mes questions de sécurité ne s’affichent-elles pas avant la session de signature ?

Les questions de sécurité sont compatibles uniquement avec la signature en ligne (signature web intégrée) avec SDK Android DocuSign avant le lancement de la session de signature.

Nous vous conseillons en outre de vérifier les paramètres de votre enveloppe. Lorsque vous envoyez une enveloppe depuis le portail web DocuSign, vérifiez le paramètre In Person ID Check Question (Question de vérification d’identité en personne).


Pourquoi la méthode UseTemplateOnline renvoie-t-elle l’erreur « Aucun modèle trouvé » ?

Cette erreur indique que le modèle référencé n’est pas disponible. Vous devez mettre le modèle en cache avant d’invoquer la méthode UseTemplateOnline. Pour mettre le modèle en cache, utilisez la méthode cacheTemplate.


Existe-t-il un exemple de code complet montrant comment implémenter la signature d’un document à l’aide d’une session de signature intégrée et de DSEnvelopeDefaults ?

L’application d’essai Kotlin de SDK Android est très complète et présente les sessions de signature hors ligne et en ligne via DSEnvelopeDefaults.


Existe-t-il une version du SDK qui ne dépend pas d’AndroidX ?

Le SDK Android requiert AndroidX et ne prend pas en charge les applications non AndroidX. Nous vous suggérons de faire migrer votre application vers AndroidX.


Pourquoi est-ce que je reçois l’erreur « Seul un nom de rôle est autorisé pour les destinataires en personne » lors de l’utilisation de la méthode useTemplateOnline() du SDK ?

Cette erreur indique que le modèle n’a pas été configuré correctement. Dans le portail web DocuSign, vérifiez que le Rôle est défini pour le destinataire dans le modèle. Dans le modèle, ne définissez aucune valeur pour les champs Nom, Nom de l’hôte ou E-mail de l’hôte. Les valeurs des destinataires seront préremplies avec des valeurs provenant de DSEnvelopeDefaults à l’aide de la méthode SDK.


Lorsque le paramètre minifyEnabled est défini sur « true » dans Proguard, pourquoi ne puis-je pas lancer la session de signature (méthode useTemplateOnline() du SDK) ?

Il vous manque peut-être des configurations de niveau Gradle. Vérifiez que le fichier build.gradle de votre application comporte la ligne suivante :

Android_minifyEnabled.PNG


Lors de l’utilisation d’un modèle, j’ai pré-rempli les valeurs des champs de texte en utilisant DSEnvelopeDefaults. Pourquoi les valeurs ne s’affichent-elles pas dans l’application pendant la session de signature ?

Vérifiez que le modèle est configuré correctement dans le portail web DocuSign. Il arrive fréquemment que les champs de texte ne soient pas mappés correctement vers le destinataire prévu.


Comment retirer le bouton à bascule d’optimisation pour les appareils mobiles qui s’affiche dans la session de signature en ligne ?

Si vous souhaitez désactiver la signature mobile, il faudra que vous demandiez à l’administrateur de votre compte de le faire dans les paramètres du compte. Dans le portail web DocuSign, l’administrateur doit aller dans Paramètres de signature, puis désactiver l’option Autoriser les destinataires à afficher des documents compatibles sur mobile avec l’Espace Signer adaptatif.


Puis-je désactiver le bouton à bascule d’optimisation pour les appareils mobiles qui s’affiche dans la session de signature en ligne pour un modèle spécifique ?

Oui. Dans le portail web DocuSign, vous pouvez désactiver l’Espace Signer adaptatif pour un modèle particulier en procédant comme suit :

  1. Sélectionnez le modèle.
  2. Modifiez le modèle.
  3. Naviguez jusqu’à Message à tous les destinataires.
  4. Sélectionnez Options avancées.
  5. Sélectionnez Modifier.
  6. Naviguez jusqu’à Affichage compatible sur mobile avec Espace Signer adaptatif.
  7. Décochez Autoriser les destinataires à consulter des documents plus facilement sur un appareil mobile.

Le SDK Android prend-il en charge des fichiers PDF protégés par mot de passe lors de la création d’enveloppes pour la signature ?

Le SDK Android ne prend pas en charge les PDF protégés par mot de passe pour la préparation des enveloppes. Vous devez retirer la protection par mot de passe ou le cryptage du PDF pour pouvoir utiliser le document.


Pourquoi est-ce que je reçois l’erreur « Impossible d’effectuer l’authentification en utilisant le jeton d’accès fourni » lors de l’utilisation de la méthode login() du SDK avec un jeton d’accès ?

Vérifiez si l’environnement est configuré sur démo ou sur production.

Si vous utilisez l’environnement de démo, vérifiez que vous l’avez configuré après avoir initialisé l’instance DocuSign comme suit :

Android_Unable_To_Authenticate_1.PNG

Si vous utilisez l’environnement de production, vérifiez que vous l’avez configuré après avoir initialisé l’instance DocuSign comme suit :

Android_Unable_To_Authenticate_2.PNG


Pourquoi est-ce que je reçois l’erreur « La mise en cache du modèle n’est pas prise en charge pour » lors de la mise en cache d’un modèle à l’aide de la méthode cacheTemplate() du SDK ?

Si le modèle contient des types d’onglets non pris en charge par le SDK Android, retirez-les du modèle dans le portail web DocuSign.

Le SDK Android prend en charge les types d’onglets suivants :

  • Signature
  • Paraphe
  • Prénom
  • Nom
  • Texte
  • Nom complet
  • Société
  • Fonction
  • Date de la signature
  • Case à cocher
  • Liste
  • Radio

Le SDK Android ne prend pas en charge les types d’onglets suivants :

  • E‑mail
  • Approuvez
  • Refuser
  • Date
  • Formule
  • Identifiant d’enveloppe
  • Annotation
  • Notarier
  • Nombre
  • Pièce jointe du signataire
  • SSN
  • Afficher
  • Code postal
  • Adresse e-mail

Pourquoi est-ce que je reçois l’erreur « Espace Signer mobile désactivé » lors de la mise en cache d’un modèle à l’aide de la méthode cacheTemplate() du SDK ?

Dans le portail web DocuSign, naviguez jusqu’à Paramètres, puis sélectionnez Paramètres de signature. Vérifiez que le paramètre Autoriser les destinataires à signer sur un appareil mobile est activé.


Pourquoi est-ce que je reçois l’erreur « Le compte utilisateur ne permet pas une utilisation hors ligne » lors de la mise en cache d’un modèle à l’aide de la méthode cacheTemplate() du SDK ?

Dans le portail web DocuSign, naviguez jusqu’à Paramètres, puis sélectionnez Paramètres de signature. Vérifiez que le paramètre Autoriser la signature sur un appareil mobile en mode hors connexion est activé.


Pourquoi est-ce que je reçois l’erreur « La signature en mode hors ligne par un destinataire est désactivée » lors de la mise en cache d’un modèle à l’aide de la méthode cacheTemplate() du SDK ?

Dans le portail web DocuSign, naviguez jusqu’à Paramètres, puis sélectionnez Paramètres de signature. Vérifiez que le paramètre Autoriser les destinataires à signer des documents sur un appareil mobile en mode hors connexion est activé.


Références