Intégrer la référence SDK

Installer

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

Après le chargement, window.Checkify.version signale la version SDK (actuellement 1.0.4).

Montage automatique HTML

Le SDK monte automatiquement les éléments avec ces attributs lors du chargement de la page :

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

Obsolète : data-checkify-launcher fonctionne toujours mais enregistre un avertissement de console. Utilisez plutôt le type de requête Pass +.

attributs d'intégration de formulaire

Lorsque vous utilisez Checkify.bindForm, vous pouvez également définir ces éléments sur le formulaire :

Checkify.configure(options)

Définissez les paramètres globaux par défaut avant de monter les widgets.

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

Checkify.bindForm(form, options)

Render est un bouton de vérification, écrit un jeton sur une entrée masquée et désactive la soumission jusqu'à vérification.

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

options bindForm

Options courantes passées comme deuxième argument à Checkify.bindForm(form, options) :

Checkify.createHumanGate(options)

Porte pleine page ou conteneur qui bloque le contenu jusqu'à ce que la vérification soit terminée.

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

Flux d'URL de retour

Lorsque les utilisateurs terminent la vérification dans l'application Checkify, ils peuvent revenir sur votre site avec checkify_request_id dans la chaîne de requête. Le SDK appelle Checkify.checkReturnedVerification() automatiquement lors du chargement.

Checkify.verify(options)

Démarrage programmatique sans bindForm. Passez un élément DOM comme target (pas container — container est réservé à createHumanGate). Préférez bindForm pour les formulaires. Renvoie une promesse résolue lorsque l’utilisateur termine ou annule.

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

Événements

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

Interrogation de l'état (facultatif)

La plupart des intégrations doivent effectuer une vérification lors de la soumission du formulaire via la requête POST /v1/qr/results/verify. Pour les interfaces personnalisées sans intégration, vous pouvez interroger régulièrement le statut pendant que l'utilisateur effectue la vérification dans l'application.

• Jeton de sondage hérité des anciens modules intégrés :
• ID de la requête + jeton d'état de la réponse initiale :

Vérification du serveur

Méthodes