Événements

Lors de l'intégration de l'un des SDK, il est nécessaire de configurer les événements requis pour son fonctionnement. Ces événements sont documentés ci-dessous :

onSDKReady

Callback exécuté lorsque le SDK se charge avec succès. Une fois le SDK chargé, un message contenant les informations d'intégration est envoyé à l'iframe.

Exemple d'utilisation

function onSDKReady() {
  console.log('SDK Initialized Successfully');
  //....
}

onSDKClose

Callback exécuté lorsque le SDK se ferme à la fin du parcours. Il n'est pas exécuté lors d'une fermeture forcée (par exemple, en fermant l'onglet).

Exemple d'utilisation

SDK-UPLOAD

/**
* @param {string} code - Code of the created document.
*/
function onSDKClose(code) {
  console.log('Document created:', code);
  //....
}

SDK-SIGN

/**
* @param {string} code - Code of the created document, not used in sdk-sign.
* @param {string} redirect - Redirect link upon completion of the signing process.
*/
function onSDKClose(code = "", redirect) {
  console.log('Recommended redirect link:', redirect);
  window.open(redirect)
  //....
}

SDK-VALIDATION

/**
* @param {string} similarity - Percentage of similarity detected in the process.
* @param {string} status - Status of the validation process.
*/
function onSDKClose(similarity, status) {
  console.log(similarity, status);
  //....
}

onSDKFinish

info

Cet événement est actuellement disponible uniquement dans SDK-SIGN.

Callback exécuté lorsque l'utilisateur termine avec succès le processus de signature, mais avant que le SDK n'affiche l'écran de fin. Il permet d'exécuter une logique personnalisée (telle que des analyses, des notifications ou des mises à jour de statut) immédiatement après la signature.

Exemple d'utilisation

function onSDKFinish() {
  console.log('User has signed successfully');
  // Run logic before the finish screen is displayed
  //....
}

onSDKToken

avertissement

Si la clé publique est incluse dans la bibliothèque d'intégration, cet événement n'est pas appelé, bien qu'il soit recommandé de l'inclure et de renvoyer la chaîne de la clé publique.

Callback exécuté lorsque le SDK a besoin d'un jeton d'autorisation pour extraire des informations de l'API.

Exemple d'utilisation

/**
 * @returns Promise<string> - This function should return a promise that
 * resolves the authentication key string
 */
function onSDKToken() {
  return new Promise((resolve) => {
    //....
    resolve('authKey');
  });
}