OneSpan Sign Developer: Rôle vs Signer - Partie 2
La semaine dernière, nous avons exploré la structure JSON de Role and Signer, le sens détaillé de ces deux concepts, ainsi que les méthodes pour récupérer les ID pour eux de manière REST. Dans ce blog, je vais vous guider à travers les scénarios et les appels API où vous aurez besoin d'utiliser l'ID de rôle avec l'ID Signer.
Pour commencer, récapitulons brièvement Role et Signer :
- Signer contient les informations personnelles de l'utilisateur, et il est inclus dans le rôle.
- Le rôle agit en tant que placeholder et est lié à l'approbation (s) qui sont constitués des signatures et des champs d'un signataire.
Si vous êtes encore confus ou vous avez manqué quelque chose, vous pouvez bien faire vérifier mon blog de la semaine dernière, "OneSpan Sign Developer: Role vs Signer" ou poster une question dans notre Forum des développeurs.
Où utiliser l'ID De zona
Rappelez-vous, Signer est lié à la personne spécifique. L'adresse e-mail est la seule chose à identifier uniquement un signataire, et Signer ID peut être remplacé par e-mail. Voici deux scénarios où vous utilisez Signer ID dans lequel il colle à l'e-mail du signataire:
Pour récupérer l'état de signature :
OneSpan Sign vous fournit différents grains de recherche pour l'état de signature, ce qui signifie que vous pouvez vérifier l'état pour l'ensemble du paquet ou tout simplement pour un signataire dans un document spécifique. Vous pouvez choisir en option les paramètres de signataire et de document ci-dessous dans l'URL API pour atteindre ceci :
GET /api/packages/'packageIdMD/signingStatus?signerId-documentId
Consultez ce post forum pour plus de détails.
Pour récupérer le jeton d'authentification :
Un jeton d'authentification est utilisé pour obtenir une session valide pour un signataire ou pour générer l'URL de signature.
Il y a trois appels API pour récupérer authToken pour un signataire :
POST /api/authentificationTokens/signer/singleUse
POST /api/authentificationTokens/signer/multiUse
POST /api/signerAuthenticationTokens
Le premier appel API est de générer une seule utilisation de jeton d'authentification. Alors que les deux dernières API génèrent toutes deux une utilisation multiple d'authToken afin que vous puissiez les considérer comme interchangeables, toutes sont ascompérables avec la même charge utile de demande :
{
"packageId": "votre forfait id",
"signerId": "Sign ID ou signsigner email"
}
remarquer:
- Vous ne pouvez générer qu'un jeton d'authentification pour votre signataire avec un package dans un statut "SENT". Dans le cas contraire, vous recevrez une "erreur 400" expliquant que ce paquet est dans un état non valide.
- L'e-mail de Signer fonctionne également dans la charge utile de la demande.
- Tous les jetons d'authentification expireront dans 30 minutes.
- Les deux sessionToken (généré par authToken) et authentificationToken peut être utilisé pour générer l'URL de signature pour un signataire en remplaçant le titulaire de place dans cette URL: https://sandbox.esignlive.com/access?sessionToken-signerAuthToken
Où utiliser l'ID de rôle
L'ID de rôle a une utilisation plus large que l'ID Designer. Dans notre site de spécifications API, vous pouvez trouver des exemples détaillés de services où l'ID de rôle est utilisé :
- Gérer un rôle
- Pour réorganiser un rôle
- Pour déverrouiller un signataire
- Pour envoyer une invitation par e-mail pour la signature
- Pour envoyer un code d'authentification SMS à un signataire
En outre, vous pouvez également utiliser Role ID dans les scénarios suivants :
Pour générer l'URL de signature pour un signataire
Outre l'utilisation de l'ID Signer pour générer une URL de signature, vous pouvez également suivre ci-dessous API. L'URL générée est différente de celle ci-dessus et peut être utilisée plusieurs fois. Cette URL est comme celle que le Signataire recevrait dans son e-mail. Vous ne voudriez probablement pas intégrer cette URL dans les src d'un iframe car il n'expire pas.
GET /api/packages/'packageId/roles/'roleId/signingUrl
Pour extraire l'image signature d'un signataire
Une fois que votre signataire a capturé sa signature, vous pouvez télécharger l'image de signature et la stocker dans votre propre système pour une utilisation ultérieure. La taille d'image téléchargée par défaut est de 350 x 100 pixels, et cette fonctionnalité n'est disponible que pour la version 11 de OneSpan Sign.
Demande HTTP
GET /api/packages/'packageId/roles/'roleId/signatureImage
En-têtes HTTP
Accepter : image/png,image/jpeg,image/gif
Content-type: application/JSON
Autorisation: api_key de base
Si vous avez des questions concernant ce blog ou quoi que ce soit d'autre sur l'intégration oneSpan Sign dans votre application, visitez les Forums communautairesdes développeurs . Vos commentaires sont importants pour nous!
