OneSpan Sign Developer: Rôle vs Signer - Partie 1
Dans OneSpan Sign, Role et Signer sont deux concepts différents. En un mot, un rôle contient unS igner, mais alors que le rôle est lié à l'approbation de signature, Signer contient des informations sur le signataire. Toujours confus ? Dans ce blog, nous allons essayer de démêler ces deux concepts.
Expliquer le rôle et le signataire?
Pour apporter une image plus directe de Role et Signer, ci-dessous est une structure de charge utile commune que vous pouvez voir dans votre réponse en appelant
GET /api/packages/ 'packageId'
Commençons par Signer, car il est probablement plus familier pour vous. Comme vous pouvez le voir sur la charge utile, tous les attributs décrivent les informations personnelles de votre destinataire, y compris les paramètres de profil de base, la méthode d'authentification, etc. En d'autres termes, Signer varie d'une personne à l'autre, et la seule chose pour identifier un signataire au sein d'une transaction est l'adresse e-mail. C'est-à-dire que vous pouvez utiliser l'adresse e-mail pour remplacer l'ID DeSigner dans les appels API partout où un ID Signer est nécessaire.
"Role" est un concept d'abstraction décrivant combien de fonctions liées aux signataires seront accordées sans savoir qui est réellement le signataire. Si vous avez essayé notre fonctionnalité De template, vous saurez que dans un package Template, vous pouvez laisser les informations du signataire vides et ces informations peuvent être injectées jusqu'à la création d'un paquet réel. De ce point de vue, Role agit en tant que placeholder qui vous permet de concevoir vos documents avec des champs de signature et d'attribuer des fonctions à ces rôles sans connaître vos signataires.
De plus,:
- L'e-mail peut remplacer complètement l'ID Signer n'importe où lors de l'appel API, qu'il soit utilisé dans une URL API ou dans une charge utile de demande
- Une approbation (trouvée dans la bonne partie de la capture d'écran) représente une boîte de signature assignée à un rôle, ce qui signifie qu'elle doit correspondre à un ID de rôle existant
- Chaque rôle contient un Signataire. Bien que vous puissiez voir des « signataires » avec une valeur de tableau JSON, il s'agit en fait d'une cartographie en tête-à-tête. Même dans la fonction Signataire du groupe, tous les membres du groupe sont dans un objet signataire de groupe
Récupérer dans SDK
Dans le processus de programmation réel, la récupération d'un ID de rôle ou d'un ID De signer pour autant d'appels d'API en aura besoin est le plus important. Ci-dessous, j'ai inclus java SDK code comme un exemple pour démontrer comment les obtenir.
ID de rôle :
Pour récupérer l'ID de rôle, OneSpan Sign SDK nous permet de localiser le rôle à l'aide d'une adresse e-mail :
EslClient eslClient - nouveau EslClient (API_KEY, API_URL);
DocumentPackage documentPackage - eslClient.getPackage (nouveau PackageId("votre id paquet"));
Rôle de chaîneId - documentPackage.getSigner ("sign's id").
ID De signataire :
Comme mentionné ci-dessus, Signer ID peut être remplacé par l'e-mail du signataire car il est unique au sein d'une seule transaction, mais ils peuvent toujours être récupérés avec l'extrait de code suivant:
import com.silanis.esl.api.model.Role;
import com.silanis.esl.api.model.Signer;
Chaîne signataires -";
Liste des rôles - eslClient.getPackageService().getRoles(nouveau PackageId("votre id paquet"));
pour (Rôle : rôles)
Signataire signataire - role.getSigners().get(0);
si (signer.getEmail().equals ("email du signataire"))
signid - role.getSigners().get(0).getId();
pause;
}
}
Comme vous pouvez le voir, les objets Role et Signer sont tous des modèles API (importés du paquet de modèles). C'est parce que depuis signataire Id peut être directement remplacé par e-mail, de sorte que dans le niveau SDK, ces deux concepts sont combinés en un seul objet (com.silanis.esl.sdk.Signer). L'attribut ID dans cet objet Signer est en fait L'ID de rôle.
Lien vers la poste
Dans mon prochain blog, nous allons parler des scénarios et des appels API où vous aurez besoin d'utiliser Role ID ainsi que Signer ID.
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 le Forum communautairedes développeurs. Vos commentaires sont importants pour nous!
