Bädda in SDK-referensen

Installera

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

Efter lastning, window.Checkify.version rapporterar SDK-utgåvan (för närvarande 1.0.4).

HTML-automontering

SDK monterar automatiskt element med dessa attribut när sidan laddas:

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

Föråldrad: data-checkify-launcher fungerar fortfarande men loggar en konsolvarning. Använd Pass + förfrågningstyp istället.

Attribut för formulärintegration

När du använder Checkify.bindForm kan du även ställa in dessa på formulärelementet:

Checkify.configure(options)

Ställ in globala standardvärden innan du monterar widgetar.

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

Checkify.bindForm(form, options)

Render är en verifieringsknapp, skriver en token till en dold indata och inaktiverar skicka tills verifierad.

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

bindForm-alternativ

Vanliga alternativ som skickas som andra argument till Checkify.bindForm(form, alternativ):

Checkify.createHumanGate(options)

Helsides- eller containergrind som blockerar innehåll tills verifieringen är klar.

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

Retur-URL-flöde

När användare slutför verifieringen i Checkify-appen kan de återvända till din webbplats med checkify_request_id i frågesträngen. SDK anropar Checkify.checkReturnedVerification() automatiskt vid laddning.

Checkify.verify(alternativ)

Starta verifiering programmatiskt utan att automatiskt montera HTML. Returnerar ett löfte som löses när användaren slutför eller avbryter.

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

Händelser

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

Statusundersökning (valfritt)

De flesta integrationer bör verifieras via formulär som skickas med POST /v1/qr/results/verify. För anpassade gränssnitt utan inbäddning kan du kontrollera statusen medan användaren slutför verifieringen i appen.

• Äldre omröstningstoken från äldre inbäddningar:
• Begäran-ID + statustoken från startsvaret:

Serververifiering

Metoder