تضمين SDK مرجع

التثبيت

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

بعد التحميل، يُبلغ window.Checkify.version عن إصدار SDK (حاليًا 1.0.4).

التحميل التلقائي لـ HTML

يقوم SDK بتثبيت العناصر تلقائيًا بهذه السمات عند تحميل الصفحة:

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

مهمل: data-checkify-launcher لا يزال يعمل ولكن يسجل تحذير وحدة التحكم. استخدم Pass + نوع الطلب بدلاً من ذلك.

سمات تكامل النموذج

عند استخدام Checkify.bindForm، يمكنك أيضًا تعيين هذه القيم على عنصر النموذج:

Checkify.configure(options)

قم بتعيين الإعدادات الافتراضية العامة قبل تثبيت الأدوات.

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

Checkify.bindForm(form, options)

Render هو زر التحقق، ويكتب رمزًا مميزًا لإدخال مخفي، ويعطل الإرسال حتى يتم التحقق منه.

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

خيارات ربط النموذج

الخيارات الشائعة التي يتم تمريرها كوسيط ثانٍ إلى Checkify.bindForm(form, options):

Checkify.createHumanGate(options)

صفحة كاملة أو بوابة حاوية تحظر المحتوى حتى اكتمال التحقق.

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

إرجاع تدفق عنوان URL

عندما يكمل المستخدمون التحقق في تطبيق Checkify، يمكنهم العودة إلى موقعك مع checkify_request_id في سلسلة الاستعلام. يقوم SDK باستدعاء Checkify.checkReturnedVerification() تلقائيًا عند التحميل.

Checkify.verify(options)

بدء برمجي دون bindForm. مرّر عنصر DOM كـ target (وليس container — container مخصص لـ createHumanGate فقط). يُفضَّل bindForm للنماذج. يعيد وعدًا يُحَل عند إكمال المستخدم أو الإلغاء.

const result = await Checkify.verify({
  passId: 'YOUR_PASS_ID',
  requestType: 'human',
  container: document.getElementById('checkify-root')
});
console.log(result.requestId); // send to your server as request_id

الفعاليات

window.addEventListener('checkify:verified', (e) => {
  console.log('Verified', e.detail);
});

window.addEventListener('checkify:error', (e) => {
  console.error('Checkify error', e.detail);
});

استطلاع الحالة (اختياري)

ينبغي لمعظم عمليات التكامل التحقق من صحة البيانات عند إرسال النموذج باستخدام طلب POST /v1/qr/results/verify. أما بالنسبة للواجهات الأمامية المخصصة التي لا تتضمن تضمينًا، فيمكنك استطلاع حالة البيانات أثناء قيام المستخدم بإكمال عملية التحقق داخل التطبيق.

• رمز استطلاع قديم من عمليات التضمين السابقة:
• معرّف الطلب + رمز الحالة من استجابة البداية:

التحقق من الخادم

طُرق