เริ่มต้นใช้งาน
ข้อมูลหลัก
อื่นๆ

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

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

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

สภาพแวดล้อม

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

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

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"
Info
เราแนะนำให้ใช้ค่าที่ไม่ซ้ำกันทั่วโลก (เช่น UUID) สำหรับ id เพื่อให้ติดตามคำขอของผู้ใช้ได้อย่างถูกต้อง
Caution
หากต้องการดาวน์โหลดไฟล์ (PDF, JPG, PNG ฯลฯ) ที่ลิงก์อยู่ในฟิลด์เอกสาร โปรดตรวจสอบว่าเป็นไปตามข้อกำหนดต่อไปนี้:
  1. 1.
    Public accessibility: ต้องเข้าถึงไฟล์ได้โดยไม่ต้องยืนยันตัวตน
  2. 2.
    Domain whitelisting: โดเมนของคุณต้องถูกเพิ่มลงใน allowlist ของไฟร์วอลล์ VPC ของ 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
Info
หมายเหตุ: CURL ส่งคืนค่าไม่ถูกต้อง \u0026 แทนที่จะเป็น &. กรุณาแทนที่ \u0026 ด้วย & ในการเปลี่ยนเส้นทาง URL. ไคลเอ็นต์อื่นไม่ควรพบปัญหานี้

พฤติกรรม

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

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

หากต้องการอัปเดตเอกสารรับรองด้วยเวอร์ชันใหม่ของเอกสารรับรองเดิม พาร์ทเนอร์ต้องส่งคำขอใหม่โดยใช้ค่าเดิมสำหรับฟิลด์บางรายการที่ใช้ในการส่งข้อมูลครั้งแรก
สถานการณ์ที่อาจจำเป็นต้องทำเช่นนี้ ได้แก่:
  • ผู้ใช้กำลังอัปเดตเอกสารรับรองเนื่องจากเอกสารเดิมใกล้หมดอายุ
  • ผู้ใช้ทำการประเมินใหม่สำหรับเอกสารรับรองที่อิงผลการประเมิน และได้รับคะแนนใหม่แล้ว
  • ผู้ใช้ที่มีคุณวุฒิการศึกษาในสถานะ 'awaiting graduation' ได้รับการมอบวุฒิแล้ว
เพื่อให้ข้อมูลรับรองเวอร์ชันใหม่ของข้อมูลรับรองเดียวกันมาแทนที่ข้อมูลรับรองเดิม ฟิลด์ต่อไปนี้ต้องเหมือนเดิม:
  • Education: course_name, conferral_year, majors (หากมี), with_honours (หากมี)
  • English Proficiency: test_name, test_provider
  • Learning and Development: microcredential_name, issuer_name
การดำเนินการนี้จะสร้างคำขอ Add to SEEK Pass ใหม่ ซึ่งต้องส่งให้ผู้ใช้ เพื่อให้ผู้ใช้สามารถอัปเดตข้อมูลเอกสารรับรองของตนได้