Einbetten von SDK-Referenz

Installieren

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

Nach dem Laden meldet window.Checkify.version die SDK-Version (derzeit 1.0.4).

HTML-Auto-Mount

Der SDK mountet Elemente mit diesen Attributen automatisch beim Laden der Seite:

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

Veraltet: data-checkify-launcher funktioniert immer noch, protokolliert jedoch eine Konsolenwarnung. Verwenden Sie stattdessen den Anforderungstyp „Pass +“.

Formularintegrationsattribute

Bei Verwendung von Checkify.bindForm können Sie diese auch für das Formularelement festlegen:

Checkify.configure(options)

Legen Sie globale Standardeinstellungen fest, bevor Sie Widgets bereitstellen.

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

Checkify.bindForm(form, options)

Renders ist eine Überprüfungsschaltfläche, schreibt ein Token in einen versteckten Eingang und deaktiviert die Übermittlung bis zur Überprüfung.

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

bindForm-Optionen

Allgemeine Optionen, die als zweites Argument an Checkify.bindForm(form, options) übergeben werden:

Checkify.createHumanGate(options)

Ganzseitiges oder Container-Gate, das den Inhalt blockiert, bis die Überprüfung abgeschlossen ist.

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

URL-Fluss zurückgeben

Wenn Benutzer die Überprüfung im abschließen Wenn Sie eine Checkify-App verwenden, kehren sie möglicherweise mit checkify_request_id in der Abfragezeichenfolge zu Ihrer Website zurück. Der SDK ruft Checkify.checkReturnedVerification() automatisch beim Laden auf.

Checkify.verify(options)

Programmatischer Start ohne bindForm. Übergeben Sie ein DOM-Element als target (nicht container — container gilt nur für createHumanGate). Bevorzugen Sie bindForm für Formulare. Gibt ein Promise zurück, das aufgelöst wird, wenn der Nutzer abschließt oder abbricht.

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

Ereignisse

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

Statusabfrage (optional)

Die meisten Integrationen sollten beim Absenden des Formulars eine Überprüfung mit POST /v1/qr/results/verify durchführen. Bei benutzerdefinierten Frontends ohne Einbettung können Sie den Status abfragen, während der Benutzer die Überprüfung in der App abschließt.

• Legacy-Abfragetoken aus älteren Einbettungen:
• Anforderungs-ID + Status-Token aus der Startantwort:

Server überprüfen

Methoden