เปลี่ยนเส้นทางผู้ใช้

หน้านี้มีการเปลี่ยนแปลงสำคัญล่าสุด กรุณาดู บันทึกประจำรุ่น สำหรับข้อมูล

การดึงรายละเอียดคำขอ

ดึงข้อมูลคำขอที่มีอยู่จาก SEEK Pass โดยใช้เอนด์พอยต์ status หรือ bulk status เอนด์พอยต์เหล่านี้จะส่งกลับข้อมูลเกี่ยวกับหนึ่งคำขอหรือหลายคำขอ เช่น สถานะของคำขอ เวลาที่คำขอเสร็จสิ้น และ redirect URI สำหรับผู้ใช้

นี่คือวิธีที่แนะนำในการเปลี่ยนเส้นทางผู้ใช้ที่มีคำขอเดิมอยู่แล้วไปดำเนินการส่งข้อมูลรับรองของตนบน SEEK Pass ให้เสร็จสิ้นหรือดูการส่งข้อมูลรับรองดังกล่าว การพยายามสร้างคำขอใหม่เพื่อสร้าง redirect URI ไม่ใช่วิธีที่แนะนำ

การส่งข้อมูล

ส่งข้อมูลผู้ใช้ไปยัง SEEK Pass โดยใช้ endpoint ที่ถูกต้องตามประเภทเอกสารรับรอง ตัวอย่างเช่น สำหรับประเภทเอกสารรับรอง การศึกษา endpoint ที่ต้องเรียกใช้คือ: /api/partner/v1/add/education.json.

สภาพแวดล้อม

ปลายทาง (endpoint) ของสภาพแวดล้อม staging และ production อยู่ด้านล่าง:

Staging: https://app.seekpass-staging.com
Production: https://app.seekpass.co

ตัวอย่างคำขอ

export CREDENTIAL_TYPE=education

export PAYLOAD='{
  "id": "seek-pass-test-a9a4839f-53d9-4064-8b0b-1348113a33f8",
  "document_type": "open_cert",
  "credential_type": "education",
  "data": {
    "credential": {
      "full_name": "John Smith",
      "education_provider": "University of Melbourne",
      "course_name": "Bachelor of Commerce",
      "conferral_year": "2024",
      "has_majors": true,
      "majors": ["Finance"],
      "with_honours": true
    },
    "document": "<OPEN_CERTS>"
  }
}'

curl -L $SEEK_PASS_URL/api/partner/v1/add/$CREDENTIAL_TYPE.json \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $ACCESS_TOKEN" \
--data "$PAYLOAD"

เราแนะนำให้ใช้ค่าที่ไม่ซ้ำกันทั่วโลก (เช่น UUID) สำหรับ id เพื่อให้ติดตามคำขอของผู้ใช้ได้อย่างถูกต้อง

เมื่อเรียกใช้ endpoint นี้ด้วย ID ที่มีอยู่แล้ว คุณต้องทราบสถานะของคำขอที่มีอยู่ ระบบจะปฏิเสธ ID ที่เชื่อมโยงกับคำขอที่กำลังดำเนินการอยู่ และควรเปลี่ยนเส้นทางผู้ใช้ไปดำเนินการส่งข้อมูลรับรองของตนบน SEEK Pass ให้เสร็จสิ้นแทน โดยใช้ request status endpoint(s) เพื่อดึง URI ที่เกี่ยวข้อง

เพื่ออัปโหลดไฟล์ (PDF, JPG, PNG ฯลฯ) ที่ส่งผ่านเป็น URL ในฟิลด์ document กรุณาตรวจสอบให้แน่ใจว่าเป็นไปตามข้อกำหนดต่อไปนี้:

1.
การเข้าถึงแบบสาธารณะ: URL ต้องเข้าถึงได้โดยไม่ต้องมีเฮดเดอร์เพิ่มเติมหรือการยืนยันตัวตนผ่านเบราว์เซอร์
2.
การเพิ่มโดเมนในรายการที่อนุญาต: โดเมนต้องอยู่ในรายการที่อนุญาตของ SEEK Pass

กรุณาติดต่อทีมงานของเราเพื่อขอเพิ่มโดเมนในรายการที่อนุญาต

รหัสการตอบกลับ

201 สร้างแล้ว: คำขอสำเร็จ

{
    "redirect_uri": "https://app.seekpass-staging.com/partner/add/education#clientId=730845ab-0a0d-4f4d-9c98-d871755d3ce9&documentType=open_cert&content=d8a8eb57-c64f-4fc1-b362-b8df28fbf0a3"
}

URL รูปแบบ

การเปลี่ยนเส้นทาง URL ถูกสร้างด้วยรูปแบบนี้:

Path: /partner/add/[CREDENTIAL TYPE]
ตัวอย่าง:
- สำหรับการศึกษา: /partner/add/education
- สำหรับความสามารถทางภาษาอังกฤษ: /partner/add/englishProficiency
- สำหรับการเรียนรู้และพัฒนาตนเอง: /partner/add/microcredential
Hash: พารามิเตอร์ด้านล่าง ซึ่งเข้ารหัสเป็นพารามิเตอร์การค้นหา URL
- clientId: รหัสไคลเอ็นต์ OAuth ของพาร์ทเนอร์
- documentType: ประเภทเอกสารที่ถูกต้อง
- content: รหัสคำขอของ SEEK Pass

หมายเหตุ: CURL ส่งคืนค่าไม่ถูกต้อง \u0026 แทนที่จะเป็น &. กรุณาแทนที่ \u0026 ด้วย & ในการเปลี่ยนเส้นทาง URL. ไคลเอ็นต์อื่นไม่ควรพบปัญหานี้

พฤติกรรม

การใช้ ID ซ้ำขณะที่คำขอยังรอดำเนินการ: การสร้างคำขอด้วย ID ที่มีอยู่ในช่วงที่คำขอยังไม่เสร็จสิ้นจะทำให้เกิดข้อผิดพลาด ตรวจสอบสถานะของคำขอที่มีอยู่เสมอ และตัดสินใจว่าจะนำผู้ใช้ไปยังคำขอเดิมหรือสร้างคำขอใหม่
การเชื่อมโยงผู้ใช้: เมื่อผู้ใช้เข้าถึง redirect_uri และยืนยันตัวตน ข้อมูลเอกสารรับรองจะถูกแนบกับบัญชีของผู้ใช้
การหมดอายุของคำขอที่ยังไม่ได้เชื่อมโยง: หากผู้ใช้ไม่เข้าไปที่ redirect_uri และเริ่มการส่งภายใน 48 ชั่วโมง คำขอจะถูกยกเลิกโดยอัตโนมัติ และข้อมูลเดิมจะถูกลบอย่างถาวร หลังจากนั้น คำขอที่มีอยู่จะสิ้นสุดและถูกยกเลิก และคุณสามารถใช้ ID เดิมซ้ำเพื่อสร้างคำขอใหม่ส่งให้ผู้ใช้
การหมดอายุของคำขอที่เชื่อมโยง: ผู้ใช้อาจเข้าถึง redirect_uri ได้ แต่จากนั้นออกจากกระบวนการและไม่ยืนยันการเพิ่มข้อมูลรับรองไปยังบัญชีของตน ผู้ใช้มีเวลาสูงสุด 30 วันในการกลับมายังแพลตฟอร์มและยืนยัน ทั้งนี้ขึ้นอยู่กับประเภทข้อมูลรับรอง หลังจากช่วงเวลานี้ คำขอจะถือว่าสิ้นสุดและถูกยกเลิก และคุณสามารถใช้ ID เดิมซ้ำเพื่อสร้างคำขอใหม่สำหรับส่งให้ผู้ใช้
Consent Flow: ข้อมูลเอกสารรับรองจะถูกแนบกับบัญชีของผู้ใช้เมื่อยืนยันตัวตน ไม่ว่าสถานะความยินยอมจะเป็นอย่างไร หากยังไม่ได้ให้ความยินยอม redirect_uri จะแจ้งให้ผู้ใช้ยอมรับ
พฤติกรรมหลังให้ความยินยอม: เมื่อให้ความยินยอมแล้ว หากผู้ใช้เข้าถึง redirect_uri เดิม ผู้ใช้จะถูกนำไปยังข้อมูลรับรองที่ส่งไว้
นโยบายการเก็บรักษาข้อมูล: หากผู้ใช้ดำเนินการตามขั้นตอนผู้ใช้เสร็จสิ้น แต่ไม่ได้ดาวน์โหลดและยืนยันตัวตนผ่านแอปมือถือภายใน 48 ชั่วโมง เอกสารทั้งหมดที่เกี่ยวข้องจะถูกลบอย่างปลอดภัยตามนโยบายการคุ้มครองข้อมูล

เมื่อผู้ใช้คลิกลิงก์และเข้าสู่ระบบแล้ว ข้อมูลจะถูกเชื่อมโยงเฉพาะกับผู้ใช้นั้นเท่านั้น หากผู้ใช้อื่นพยายามใช้ลิงก์เดียวกัน ระบบจะนำไปยังหน้าแสดงข้อผิดพลาด

การอัปเดตเอกสารรับรองที่มีอยู่

เมื่อออกข้อมูลรับรองใหม่ ไม่ว่าจะมีการเปลี่ยนแปลงหรือไม่ คำขอทั้งหมดควรใช้ unique ID เดิมซ้ำเพื่ออ้างถึงข้อมูลรับรองเดียวกัน ไม่สามารถออกข้อมูลรับรองใหม่ได้ขณะที่คำขอปัจจุบันกำลังดำเนินการอยู่

หากต้องการอัปเดตข้อมูลรับรองด้วยเนื้อหาใหม่ พาร์ทเนอร์ต้องส่งคำขอใหม่โดยใช้ค่าเดิมสำหรับฟิลด์เฉพาะที่ใช้ในการส่งครั้งแรก

สถานการณ์ที่อาจจำเป็นต้องทำเช่นนี้ ได้แก่:

ผู้ใช้กำลังอัปเดตเอกสารรับรองเนื่องจากเอกสารเดิมใกล้หมดอายุ
ผู้ใช้ทำการประเมินใหม่สำหรับเอกสารรับรองที่อิงผลการประเมิน และได้รับคะแนนใหม่แล้ว
ผู้ใช้ที่มีคุณวุฒิการศึกษาในสถานะ 'awaiting graduation' ได้รับการมอบวุฒิแล้ว

เพื่อให้ข้อมูลรับรองเดียวกันเวอร์ชันใหม่มาแทนที่ข้อมูลรับรองเดิมแทนที่จะปรากฏเป็นข้อมูลรับรองใหม่ ฟิลด์ต่อไปนี้ต้องคงค่าเดิม:

Education: course_name, conferral_year, majors (หากมี), with_honours (หากมี)
English Proficiency: test_name, test_provider
Learning and Development: microcredential_name, issuer_name

ก่อนหน้า: การหมดอายุและการเพิกถอน

ถัดไป: ตรวจสอบสถานะการส่งข้อมูล