Eventos

Ao integrar qualquer um dos SDKs, é necessário configurar os eventos exigidos para o seu funcionamento. Esses eventos estão documentados abaixo:

onSDKReady

Callback executado quando o SDK é carregado com sucesso. Após o carregamento bem-sucedido do SDK, uma mensagem com as informações da integração é enviada ao iframe.

Exemplo de uso

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

onSDKClose

Callback executado quando o SDK é fechado devido ao término do fluxo. Não é executado quando o fechamento é forçado (por exemplo, ao fechar a aba).

Exemplo de uso

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

Este evento está disponível atualmente apenas no SDK-SIGN.

Callback executado quando o usuário conclui com sucesso o processo de assinatura, mas antes de o SDK exibir a tela de conclusão. Isso permite executar lógica personalizada (como análises, notificações ou atualizações de status) logo após a assinatura ser concluída.

Exemplo de uso

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

onSDKToken

aviso

Se a chave pública for incluída na biblioteca de integração, este evento não é chamado, embora seja recomendado incluí-la e retornar a string da chave pública.

Callback executado quando o SDK precisa de um token de autorização para extrair informações da API.

Exemplo de uso

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