API REST
OneSpan Sign a créé une Digital Lending Solution qui peut stocker un prêt ou un autre document connexe (par exemple, un contrat, un acte mobilier) dans un coffre-fort numérique.
Certains paramètres de l'API REST associés à une transaction OneSpan Sign peuvent spécifier quel document doit être mis en coffre-fort, et dans quelle organisation et quel coffre-fort il doit être stocké. Une fois que la copie faisant autorité d'un document est mise en coffre-fort, elle est remplacée dans la base de données de OneSpan Sign par une copie non autorisée en filigrane (par défaut) ou par un document vierge.
La création d'une transaction ou d'un modèle avec l'API REST implique toujours certains paramètres standard - voir Paramètres de SDK Java.
Si vous souhaitez visualiser tous les appels existants, consultez notre Spécification API ouverte interactive. De là, vous pouvez télécharger le fichier YAML de notre API REST, rechercher des points d'extrémités spécifiques dans cette API, et même essayer quelques appels vous-même.
Chaque fois qu'une tentative de dépôt électronique de documents dans un coffre-fort eOriginal échoue, OneSpan Sign envoie une notification à l'expéditeur de la transaction associée via un événement de rappel. Une fois que l'effort de voute d'un document subit une erreur non récupérable, OneSpan Sign envoie à l'expéditeur un courriel électronique signalant l'échec. Le modèle du courriel ne peut pas être personnalisé.
Utilisation d'un coffre-fort eOriginal pour les transactions de prêt numérique
Actuellement, l'utilisation de signatures optionnelles avec eOriginal n'est pas prise en charge. Par défaut, lorsque vous utilisez eOriginal, les documents sont mis en coffre-fort dès que la dernière signature a été apposée par le dernier signataire. Toutefois, lorsque les signatures sont facultatives, il est possible d'effectuer une transaction sans remplir tous les champs de signature. Dans ce cas, le document ne serait pas mis en coffre-fort.
Si vous souhaitez stocker un document dans un coffre-fort eOriginal, la première chose à faire est de demander à notre équipe de soutien d'activer cette fonctionnalité pour votre compte.
Pour demander à OneSpan Sign de stocker un document dans un coffre-fort eOriginal, les intégrateurs doivent ajouter au champ data
de la transaction le champ vaulting_data
JSON décrit ci-dessous.
eOriginal met en sûreté un document de prêt d'une transaction OneSpan Sign ainsi que le journal d'audit de la transaction.
Depuis la version 11.37 de OneSpan Sign, si une transaction comporte plusieurs documents de prêt : (1) un coffre-fort eOriginal peut stocker tous ces documents pour la transaction; (2) la piste d'audit eOriginal répertorie tous les événements liés à la transaction et à ses multiples documents.
vaulting_data
Ce champ doit être une chaîne JSON codée en Base-64. Lorsque le champ est décodé, les paramètres du tableau suivant peuvent être visualisés.
Paramètre | Requis? | Description |
---|---|---|
vaultTransactionTypeName | Non | Cela permet aux clients du coffre-fort de transmettre au système le nom du type de transaction souhaité, via le paramètre transactiontypename . Cela permet aux utilisateurs de distinguer la source de certaines transactions lors de la mise en coffre-fort parmi plusieurs sources qu'ils souhaitent suivre. |
vaultCredentials | Oui |
Cet objet JSON contient les informations d'authentification pour accéder à l'API du service eCore d'eOriginal. Cet objet doit contenir les champs obligatoires suivants :
Cet objet JSON contient également le champ facultatif suivant (une valeur par défaut sera utilisée si le champ du point de terminaison n'est pas spécifié) :
|
documentsToVault | Oui |
Il s'agit d'un tableau JSON qui doit contenir les champs obligatoires suivants. Chaque entrée du tableau contient des informations sur la mise en coffre-fort d'un document spécifique.
Les valeurs de IdPrêt, MontantPrêt et Prêteur ne sont envoyées à eOriginal que pour le premier élément du tableau. Pour les éléments suivants, ces valeurs ne sont pas envoyées à eOriginal. |
version | Non |
Version du protocole à utiliser. Actuellement, la seule valeur prise en charge est Lending-2.0. |
postRegisterOption | Non |
Une fois que la copie faisant autorité d'un document est mise en coffre-fort dans un coffre-fort eOriginal, elle est supprimée de OneSpan Sign. Ce paramètre spécifie comment cette copie faisant autorité sera remplacée dans OneSpan Sign. Les valeurs prises en charge sont les suivantes :
Remarque : Les clients ne peuvent pas télécharger la copie faisant autorité d'un document qui sera déposé dans un coffre-fort eOriginal. S'ils essaient de le faire, ils finiront par télécharger une copie non autorisée aplatie dont chaque page portera le filigrane Copie non autorisée. |
customFields | Non |
Cet objet JSON contient des données qui seront ajoutées à la transaction eOriginal en tant que champs personnalisés. Cet objet peut contenir n'importe quel champ tant que son nom correspond à celui d'un champ personnalisé configuré pour votre service eOriginal eCore Customer Org. |
Exemple
Voici un exemple de décodage en base64 d'une valeur « vaulting_data
» décodée en base64 :
{ "postRegisterOption":"watermark_doc", "vaultTransactionTypeName":"OneSpan Sign eTest", "vaultCredentials":{ "username":"SampleUsername", "orgName":"SampleOrganization", "apiKey":"ok0Sample0ApiKey0Just0An0Example", "endpoint":"previewondemand" }, "documentsToVault":[ { "documentId":"DocumentName01", "loanId":"loanId_001", "loanAmount":"99999", "lender":"ABC Corporation", "type":"Loan Contract" }, { "documentId":"DocumentName02", "loanId":"N/A", "loanAmount":"0", "lender":"N/A", "type":"Ancillary" } ] }
Parameter | Required? | Description |
---|---|---|
vaults | Yes | |
registryRecords | Yes | |
version | No | |
postRegisterOption | No |
Modèle de courriel pour un échec de mise en coffre-fort
Si une tentative de mise en coffre d'un document échoue, OneSpan Sign utilise le modèle suivant pour envoyer à l'expéditeur de la transaction associée un courriel signalant l'échec.
Ce modèle ne peut pas être personnalisé.
<?xml version="1.0" encoding="UTF-8"?> <email-template xmlns="urn:schema.awsng.silanis.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <from> <email>[email protected]</email> <display_name>OSS Support</display_name> </from> <to> <address> <email>%USER_EMAIL;</email> <display_name>%USER_FIRST_NAME; %USER_LAST_NAME;</display_name> </address> </to> <subject>e-Sign Ceremony Failure Notification</subject> <body> <content-type>text/html; charset="UTF-8"</content-type> <content> Dear %USER_FIRST_NAME; %USER_LAST_NAME;,<br/> <br/> An error has occurred for your package: <br/> <br/> %NOTIFICATION_MESSAGE;<br/> <br/> Should you have any problem, please contact OSS Support at [email protected] <br/> <br/> Thank you for e-signing.<br/> <br/> OSS Support </content> </body> <priority>1</priority> </email-template>
La notification d'échec ci-dessus ne sera pas envoyée si l'une des erreurs suivantes se produit dans le champ JSON vaulting_data
:
Erreur | Ce que la requête POST/api/paquets retourne |
---|---|
Le champ documentId du paramètre documentsAuCoffre est incorrect (c'est-à-dire qu'il ne s'agit pas d'un IdDocument dans la transaction). | 200 |
Le champ NomUtilisateur du paramètre identifiantsCoffre est incorrect. | 200 |
Le champ cléAPI du paramètre identifiantsCoffre est incorrect. |
500 "messageKey": "error.internal.default","technical": "error.eslx.validation.eoclient.loginError” |
Le champ nomOrg du paramètre identifiantsCoffre est incorrect, mais le champ cléAPI est correct. |
500 "messageKey": "error.internal.default","technical": "error.eslx.validation.eoclient.loginError” |
JSON incorrect - par exemple, référencement de identifiantsCoffre comme identifiantsCoffre. | 200 |