Incrustar SDK referencia

Instalar

<script src="https://checkify.me/sdk/v1/checkify.min.js"></script>

Después de la carga, window.Checkify.version informa la versión SDK (actualmente 1.0.4).

Montaje automático HTML

El SDK monta automáticamente elementos con estos atributos al cargar la página:

<div
  data-checkify-pass="YOUR_PASS_ID"
  data-checkify-request="human"
  data-checkify-text="Verify with Checkify"
  data-checkify-return-url="https://yoursite.com/done"
></div>

Obsoleto: data-checkify-launcher todavía funciona pero registra un Advertencia de consola. Utilice el tipo de solicitud Pasar + en su lugar.

atributos de integración de formularios

Al usar Checkify.bindForm, también puede configurar lo siguiente en el elemento del formulario:

Checkify.configure(options)

Establezca valores predeterminados globales antes de montar widgets.

Checkify.configure({
  baseUrl: 'https://checkify.me',
  completeUrl: '/checkify/complete'
});

Checkify.bindForm(form, options)

Renders un botón de verificación, escribe un token en una entrada oculta y deshabilita el envío hasta que se verifique.

Checkify.bindForm('#my-form', {
  passId: 'YOUR_PASS_ID',
  requestType: 'human',
  buttonTarget: '#checkify-wrap',
  submitButton: '#submit',
  hiddenInput: '#checkify_token',
  disableSubmitUntilVerified: true
});

Opciones de bindForm

Opciones comunes pasadas como segundo argumento a Checkify.bindForm(form, options):

Checkify.createHumanGate(options)

Puerta de página completa o contenedor que bloquea el contenido hasta que se completa la verificación.

Checkify.createHumanGate({
  passId: 'YOUR_PASS_ID',
  requestType: 'human',
  container: '#gate-root',
  title: 'Verify to continue'
});

Flujo de URL de retorno

Cuando los usuarios completan la verificación en el Checkify aplicación, pueden regresar a su sitio con checkify_request_id en la cadena de consulta. El SDK llama a Checkify.checkReturnedVerification() automáticamente al cargar.

Checkify.verificar(opciones)

Inicio programático sin bindForm. Pase un elemento DOM como target (no container — container solo es para createHumanGate). Prefiera bindForm para formularios. Devuelve una promesa que se resuelve cuando el usuario completa o cancela.

const result = await Checkify.verify({
  passId: 'YOUR_PASS_ID',
  requestType: 'human',
  target: document.getElementById('checkify-root'),
  autoOpenModal: true
});
console.log(result.requestId); // send to your server as request_id

Eventos

window.addEventListener('checkify:verified', (e) => {
  console.log('Verified', e.detail);
});

window.addEventListener('checkify:return', (e) => {
  console.log('Returned from app', e.detail);
});

window.addEventListener('checkify:status', (e) => {
  console.log('Status', e.detail);
});

window.addEventListener('checkify:error', (e) => {
  console.error('Checkify error', e.detail);
});

Sondeo de estado (opcional)

La mayoría de las integraciones deben verificarse al enviar el formulario con POST /v1/qr/results/verify. Para interfaces personalizadas sin la función de incrustación, puede consultar el estado mientras el usuario completa la verificación en la aplicación.

• Token de encuesta heredado de incrustaciones antiguas:
• ID de solicitud + token de estado de la respuesta inicial:

Verificar servidor

Métodos