Osadź odniesienie SDK

Zainstalować

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

Po załadowaniu, window.Checkify.version informuje o wydaniu SDK (aktualnie 1.0.4).

Automatyczne montowanie HTML

SDK automatycznie montuje elementy z następującymi atrybutami podczas ładowania strony:

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

Przestarzałe: data-checkify-launcher Nadal działa, ale wyświetla ostrzeżenie w konsoli. Zamiast tego użyj Pass + typ żądania.

Atrybuty integracji formularzy

Używając Checkify.bindForm, możesz również ustawić te ustawienia w elemencie formularza:

Checkify.configure(options)

Przed zamontowaniem widżetów ustaw globalne wartości domyślne.

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

Checkify.bindForm(form, options)

Renders przycisk weryfikacji, zapisuje token w ukrytym polu wprowadzania danych i blokuje możliwość wysyłania do momentu weryfikacji.

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

opcje bindForm

Typowe opcje przekazywane jako drugi argument do Checkify.bindForm(form, options):

Checkify.createHumanGate(options)

Całostronicowa lub kontenerowa brama blokująca treść do momentu zakończenia weryfikacji.

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

Przepływ adresu URL zwrotnego

Gdy użytkownicy ukończą weryfikację w aplikacji Checkify, mogą powrócić do Twojej witryny z checkify_request_id w ciągu zapytania. SDK wywołuje Checkify.checkReturnedVerification() automatycznie po załadowaniu.

Checkify.verify(opcje)

Rozpocznij weryfikację programowo, bez automatycznego montowania kodu HTML. Zwraca obietnicę, która zostanie zrealizowana po zakończeniu lub anulowaniu przez użytkownika.

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

Wydarzenia

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

Sondowanie statusu (opcjonalnie)

Większość integracji powinna zostać zweryfikowana podczas przesyłania formularza za pomocą polecenia POST /v1/qr/results/verify. W przypadku niestandardowych interfejsów użytkownika bez osadzania, można sprawdzić status, gdy użytkownik kończy weryfikację w aplikacji.

• Stary token ankiety ze starszych osadzeń:
• Identyfikator żądania + token statusu z odpowiedzi początkowej:

Weryfikacja serwera

Metody