เริ่มต้นใช้งาน
ข้อมูลหลัก
อื่นๆ
ขั้นตอนการผสานรวม Add to SEEK Pass
หน้านี้มีการเปลี่ยนแปลงสำคัญล่าสุด กรุณาดู บันทึกประจำรุ่น สำหรับข้อมูล
การผสานรวม Add to SEEK Pass เป็นไปตามโฟลว์มาตรฐานเพื่อส่งข้อมูลเอกสารรับรองจากระบบของพาร์ทเนอร์ไปยัง SEEK Pass อย่างปลอดภัย แผนภาพลำดับนี้แสดงกระบวนการทั้งหมด
ขั้นตอนการเชื่อมต่อระบบ
พาร์ทเนอร์เตรียมข้อมูลผู้ใช้สำหรับ payload ในรูปแบบ JSON ตามประเภทข้อมูลรับรอง (เช่น คุณวุฒิการศึกษา หรือ ความสามารถทางภาษาอังกฤษ) โดยมีข้อกำหนดโดยละเอียดสำหรับแต่ละประเภทข้อมูลรับรองอยู่ในส่วนของประเภทนั้น ๆ
กระบวนการผสานรวมประกอบด้วยขั้นตอนสำคัญดังนี้:
- 1.เตรียมข้อมูลในรูปแบบ JSON ตามข้อกำหนดของประเภทเอกสารรับรอง
- 2.ยืนยันตัวตนกับ SEEK Pass เพื่อรับโทเค็นการเข้าถึง OAuth
- 3.ตรวจสอบคำขอที่มีอยู่ เพื่อพิจารณาว่าจะสร้างคำขอใหม่หรือใช้คำขอเดิมซ้ำ
- 4.
- a.หากไม่ได้ใช้คำขอเดิมซ้ำ ส่งข้อมูลผู้ใช้ เพื่อรับ URL สำหรับเปลี่ยนเส้นทาง
- b.หากใช้คำขอเดิมซ้ำ ให้ใช้ URL สำหรับเปลี่ยนเส้นทางที่ส่งกลับมาจากรายละเอียดคำขอที่ดึงมา
- 5.เปลี่ยนเส้นทางผู้ใช้ไปยัง redirect URL ที่ให้ไว้เพื่อประสบการณ์ที่ราบรื่น
- 6.(ไม่บังคับ) ตรวจสอบสถานะการส่งข้อมูล เพื่อยืนยันว่าการส่งข้อมูลสำเร็จ ถูกยกเลิก หรือยังอยู่ระหว่างดำเนินการ
การแสดงภาพประกอบ
แผนภาพด้านล่างแสดงการไหลของข้อมูลระหว่างระบบของพาร์ทเนอร์, API ของ SEEK Pass และผู้ใช้ปลายทาง:
เส้นทางการเชื่อมต่อระบบ
เวิร์กโฟลว์การผสานรวมประกอบด้วย 2 ขั้นหลัก คือ authentication และ user data submission:
การยืนยันตัวตนด้วย OAuth
เริ่มต้นด้วยการยืนยันตัวตนกับ SEEK Pass โดยใช้ OAuth 2.0
คุณจะได้รับ client ID และ client secret เมื่อคุณลงทะเบียนเป็นพาร์ทเนอร์กับ SEEK Pass
ใช้ข้อมูลรับรองเหล่านี้กับ Authentication API เพื่อรับโทเค็นการเข้าถึง OAuth สำหรับการเรียก API ครั้งถัดไป
การส่งข้อมูล
เมื่อผ่านการตรวจสอบสิทธิ์แล้ว โปรดตรวจสอบบันทึกของคุณเองว่ามีคำขอที่มีอยู่ซึ่งอาจถูกสร้างไว้แล้วสำหรับข้อมูลรับรองนี้หรือไม่ การออกข้อมูลรับรองเดิมอีกครั้งทำได้เฉพาะเมื่อคำขอเดิมเสร็จสิ้นแล้ว มิฉะนั้นระบบจะส่งกลับข้อผิดพลาด
หากคุณมีบันทึกคำขอที่มีอยู่สำหรับผู้ใช้รายเดิมและข้อมูลรับรองเดียวกันที่กำลังออก ให้เรียกใช้เอนด์พอยต์ที่เกี่ยวข้องเพื่อดึงรายละเอียดคำขอจาก Add to SEEK Pass API หากคำขอที่มีอยู่ยังไม่เสร็จสิ้น ให้นำผู้ใช้ไปยัง URL ที่ให้ไว้ จากรายละเอียดของคำขอเดิม เพื่อให้ผู้ใช้ดำเนินการใน SEEK Pass ให้เสร็จสิ้นได้อย่างราบรื่น
หากไม่มีคำขอที่มีอยู่ หรือหากคำขอที่มีอยู่เสร็จสิ้นแล้ว ให้จัดเตรียมข้อมูลผู้ใช้ของคุณในรูปแบบ JSON ตามข้อกำหนดของประเภทข้อมูลรับรองที่เกี่ยวข้อง เช่น วุฒิการศึกษา จากนั้นส่งข้อมูลนี้ผ่าน Add to SEEK Pass API และใช้ URL ที่ให้ไว้ เพื่อนำผู้ใช้ไปดำเนินการใน SEEK Pass ให้เสร็จสิ้นได้อย่างราบรื่น
คุณสามารถเลือกตรวจสอบ submission status เพื่อดูว่ากระบวนการสำเร็จ ถูกยกเลิก หรือยังอยู่ระหว่างดำเนินการ
เส้นทางการใช้งานของผู้ใช้
- 1.ผู้ใช้เข้าสู่โฟลว์: ผู้ใช้คลิกลิงก์ / กรอกรหัสที่พาร์ทเนอร์ให้มา (เช่น ผ่านรหัส / ปุ่มในอีเมล)
- 2.การตรวจสอบความถูกต้องของข้อมูล: ผู้ใช้จะถูกเปลี่ยนเส้นทางไปยัง API ของพาร์ทเนอร์เพื่อตรวจสอบความถูกต้องของข้อมูล
- 3.การสร้างลิงก์คำขอ: พาร์ทเนอร์เรียกใช้ API ของ SEEK Pass เพื่อดึงข้อมูลและ/หรือสร้างคำขอ ซึ่งจะส่งกลับ URL สำหรับเปลี่ยนเส้นทาง พาร์ทเนอร์อาจแสดงหน้ากำลังโหลดในช่วงนี้ได้ตามต้องการ
- 4.การเปลี่ยนเส้นทางผู้ใช้: จากนั้นพาร์ทเนอร์จะเปลี่ยนเส้นทางเบราว์เซอร์ของผู้ใช้ไปยัง URL ที่ให้ไว้เพื่อเพิ่มข้อมูลรับรองไปยัง SEEK Pass
- 5.กระบวนการยืนยัน: ระบบจะพาคุณดำเนินการตามขั้นตอนที่สั้นและราบรื่นเพื่อเพิ่มข้อมูลรับรองของคุณไปยัง SEEK Pass
การนำไปใช้งานทางเทคนิค
สำหรับรายละเอียดการพัฒนาเชิงเทคนิค โปรดดูส่วนเฉพาะเหล่านี้:
- การยืนยันตัวตน - ข้อมูลรับรองที่จำเป็นและการตั้งค่า OAuth
- เปลี่ยนเส้นทางผู้ใช้ - โฟลว์ผู้ใช้และการจัดการ URL
- ตรวจสอบสถานะการส่งข้อมูล - ดึงสถานะการส่งข้อมูล
- เพิกถอนคำขอ - เพิกถอนคำขอที่กำลังดำเนินการอยู่หรือคำขอที่ยืนยันแล้ว
แนวทางปฏิบัติที่ดีที่สุด
เพื่อให้ได้ผลลัพธ์การเชื่อมต่อระบบที่ดีที่สุด:
- ตรวจสอบความถูกต้องของข้อมูล payload ทุกครั้งก่อนส่ง
- ติดตามและตรวจสอบคำขอที่มีอยู่เสมอ เพื่อให้ทราบว่าควรสร้างคำขอเมื่อใดและควรใช้คำขอซ้ำเมื่อใด
- อย่าเปลี่ยน ID เดิมของข้อมูลรับรองเดียวกัน การออกข้อมูลรับรองเดียวกันใหม่โดยใช้ ID ที่ต่างกันอาจทำให้ในบางกรณีมีการเพิ่มข้อมูลรับรองนั้นไปยังบัญชีของผู้ใช้หลายครั้ง โดยเฉพาะอย่างยิ่ง อย่าสร้าง ID ใหม่ทุกครั้งที่ผู้ใช้คลิกปุ่มเพิ่มไปยัง SEEK Pass
- จัดทำการจัดการข้อผิดพลาดสำหรับการตอบกลับ API อย่างเหมาะสม
- จัดเตรียมหน้า branded loading ระหว่างการเรียก API
- ปฏิบัติตามแนวทางแบรนด์ของ SEEK Pass สำหรับตำแหน่งและการออกแบบปุ่ม
การยืนยันตัวตนด้วยอีเมล OTP – ข้อควรพิจารณาเกี่ยวกับโดเมนของพาร์ทเนอร์
หากองค์กรของคุณใช้โดเมนอีเมลที่กำหนดเอง (เช่น @youruniversity.edu.sg) โปรดตรวจสอบให้แน่ใจว่าอีเมล OTP (One-Time Password) จาก SEEK Pass ถูกส่งถึงบัญชีของคุณสำเร็จ
สิ่งที่ต้องตรวจสอบ
- ใช้อีเมลจริงจากโดเมนของคุณเพื่อทดสอบโฟลว์ OTP
- ตรวจสอบให้แน่ใจว่าอีเมล OTP ไม่ถูกบล็อกโดยไฟร์วอลล์อีเมลหรือฟิลเตอร์สแปมขององค์กรของคุณ
- ยืนยันว่าผู้ใช้สามารถเข้าสู่ระบบหรือยืนยันตัวตนให้เสร็จได้ด้วย OTP ที่ได้รับ
- หากคุณไม่สามารถรับอีเมล OTP ระหว่างการทดสอบได้ โปรดติดต่อทีม IT ของคุณเพื่ออนุญาตอีเมลจาก @seek.com.au, @seekpass.co, @seekpass-staging.com (สภาพแวดล้อม staging สำหรับการทดสอบ) หรือสอบถามผู้ติดต่อด้านการผสานรวม SEEK Pass ของคุณ