Incorpora SDK riferimento

Installa

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

Dopo il caricamento, window.Checkify.version segnala la versione SDK (attualmente 1.0.4).

Montaggio automatico HTML

Il SDK monta automaticamente gli elementi con questi attributi al caricamento della pagina:

<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>

Deprecato: data-checkify-launcher funziona ancora ma registra un avviso sulla console. Utilizza invece il tipo di richiesta Pass +.

attributi di integrazione dei moduli

Quando si utilizza Checkify.bindForm, è possibile impostare anche questi parametri sull'elemento del modulo:

Checkify.configure(options)

Imposta le impostazioni predefinite globali prima di montare i widget.

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

Checkify.bindForm(form, options)

Renders è un pulsante di verifica, scrive un token su un input nascosto e disabilita l'invio fino alla verifica.

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

opzioni di bindForm

Opzioni comuni passate come secondo argomento a Checkify.bindForm(form, options):

Checkify.createHumanGate(options)

Porta a pagina intera o contenitore che blocca il contenuto fino al completamento della verifica.

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

Flusso URL di ritorno

Quando gli utenti completano la verifica nel Checkify app, potrebbero tornare al tuo sito con checkify_request_id nella stringa di query. Il SDK chiama Checkify.checkReturnedVerification() automaticamente al caricamento.

Checkify.verify(opzioni)

Avvio programmatico senza bindForm. Passa un elemento DOM come target (non container — container è solo per createHumanGate). Preferisci bindForm per i form. Restituisce una promise che si risolve quando l’utente completa o annulla.

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

Eventi

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);
});

Sondaggio sullo stato (facoltativo)

La maggior parte delle integrazioni dovrebbe eseguire la verifica al momento dell'invio del modulo tramite POST /v1/qr/results/verify. Per i frontend personalizzati senza embed, è possibile effettuare un polling dello stato mentre l'utente completa la verifica nell'app.

• Token di sondaggio legacy proveniente da incorporamenti precedenti:
• ID richiesta + token di stato dalla risposta iniziale:

Verifica server

Metodi