เอกสารอ้างอิง Embed SDK

ติดตั้ง

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

หลังโหลด window.Checkify.version จะรายงานรุ่น SDK (ปัจจุบัน 1.0.4)

HTML ติดตั้งอัตโนมัติ

SDK จะ mount องค์ประกอบที่มีแอตทริบิวต์เหล่านี้โดยอัตโนมัติเมื่อโหลดหน้า:

<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 ยังใช้งานได้แต่จะแสดงคำเตือนใน console ใช้ Pass + ประเภทคำขอแทน

คุณลักษณะการผสานรวมแบบฟอร์ม

เมื่อใช้ Checkify.bindForm คุณสามารถตั้งค่าเหล่านี้บนองค์ประกอบฟอร์มได้ด้วย:

Checkify.configure(options)

ตั้งค่าเริ่มต้นทั่วโลกก่อน mount widget

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

Checkify.bindForm(form, options)

แสดงปุ่มยืนยัน เขียนโทเค็นลง input ที่ซ่อน และปิดการส่งจนกว่าจะยืนยันแล้ว

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

ตัวเลือก bindForm

ตัวเลือกทั่วไปที่ส่งเป็นอาร์กิวเมนต์ตัวที่สองไปยัง Checkify.bindForm(form, options):

Checkify.createHumanGate(options)

ประตูเต็มหน้าหรือใน container ที่บล็อกเนื้อหาจนกว่าการยืนยันจะเสร็จ

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

ขั้นตอน Return URL

เมื่อผู้ใช้ทำการยืนยันในแอป Checkify เสร็จ อาจกลับมายังไซต์ของคุณพร้อม checkify_request_id ใน query string SDK จะเรียก Checkify.checkReturnedVerification() โดยอัตโนมัติเมื่อโหลด

Checkify.verify(options)

เริ่มแบบโปรแกรมโดยไม่ใช้ bindForm ส่งองค์ประกอบ DOM เป็น target (ไม่ใช่ container — container ใช้กับ createHumanGate เท่านั้น) แนะนำ bindForm สำหรับฟอร์ม คืน Promise ที่ resolve เมื่อผู้ใช้เสร็จหรือยกเลิก

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

เหตุการณ์

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

การตรวจสอบสถานะ (ไม่บังคับ)

โดยทั่วไปแล้ว การเชื่อมต่อส่วนใหญ่ควรตรวจสอบความถูกต้องเมื่อส่งแบบฟอร์มด้วย POST /v1/qr/results/verify สำหรับส่วนหน้าเว็บที่กำหนดเองซึ่งไม่มีการฝังโค้ด คุณอาจตรวจสอบสถานะในขณะที่ผู้ใช้กำลังทำการยืนยันในแอป

• โทเค็นโพลเก่าจากตัวอย่างการฝังข้อมูลแบบเก่า:
• รหัสคำขอ + โทเค็นสถานะจากคำตอบเริ่มต้น:

ยืนยันฝั่งเซิร์ฟเวอร์

วิธีการ