ย้ายจาก API v1 ไป v2 API SEEK Pass v1 ถูกเลิกใช้แล้ว พาร์ทเนอร์ต้องย้ายการเชื่อมต่อที่มีอยู่ไปยัง API v2 และการเชื่อมต่อใหม่ต้องใช้ v2 กำหนดเวลาการย้ายคือ TBA
ตรวจดู
ข้อกำหนด OpenAPI v2 และตัวอย่างเพย์โหลดคำขอในแต่ละหน้าข้อมูลรับรอง แล้วอัปเดต URL ของเอนด์พอยต์และเนื้อหาคำขอ
ข้อกำหนด OpenAPI v1 ยังคงใช้เป็นข้อมูลอ้างอิงได้ขณะที่คุณวางแผนและตรวจสอบการย้าย
Education ถูกใช้เป็นตัวอย่างตลอดทั้งหน้านี้ ข้อมูลรับรองแต่ละประเภทมีเพย์โหลดและฟิลด์ของตัวเอง ดังนั้นโปรดดูส่วนประเภทข้อมูลรับรองในเอกสารสำหรับข้อมูลรับรองที่คุณกำลังย้าย
URL ของเอนด์พอยต์ เปลี่ยน /api/partner/v1 เป็น /api/partner/v2 พาธของการสร้างและสถานะก็เปลี่ยนรูปแบบด้วย ข้อมูลรับรองประเภทอื่นใช้รูปแบบ URL เดียวกันโดยมีส่วนพาธของตัวเอง เช่น english_proficiency หรือ microcredential
การดำเนินการ API v1 API v2 โทเค็น OAuth POST /api/partner/v1/oauth/token.jsonPOST /api/partner/v2/oauth/token.jsonเพิกถอนโทเค็น OAuth POST /api/partner/v1/oauth/token/revoke.jsonPOST /api/partner/v2/oauth/token/revoke.jsonสร้างคำขอ Education POST /api/partner/v1/add/education.jsonPOST /api/partner/v2/add/requests/education.jsonสร้าง batch POST /api/partner/v1/add/batch.json
POST /api/partner/v1/add/batch/microcredential.json
POST /api/partner/v2/add/requests/batch.jsonสถานะการส่งข้อมูล GET /api/partner/v1/submissions/$ID/status.jsonGET /api/partner/v2/add/requests/$CREDENTIAL_IDสถานะการส่งหลายรายการ POST /api/partner/v1/submissions/status.jsonGET /api/partner/v2/add/requests?credential_id[]=...
ฟิลด์คำขอ OAuth (grant_type, client_id, client_secret และ scope) ไม่เปลี่ยนแปลง สถานะแบบกลุ่มตอนนี้เป็น GET พร้อมพารามิเตอร์คิวรี credential_id[] ที่ซ้ำกัน แทนที่จะเป็นเนื้อหา POST ที่มี ids
Batch ไม่ใช้รูปแบบ URL เดียวกัน API v1 มี POST /api/partner/v1/add/batch.json และ POST /api/partner/v1/add/batch/microcredential.json API v2 มี endpoint batch เดียว คือ POST /api/partner/v2/add/requests/batch.json ข้อมูลรับรอง Learning and Development ในคำขอนั้นคือ microcredential_items
เพย์โหลดของข้อมูลรับรอง คุณสมบัติ Education เดียวกันแสดงในทั้งสองเวอร์ชัน ชื่อฟิลด์ภายในคุณสมบัติ เช่น
course_name และ
conferral_year ยังคงเหมือนเดิม สิ่งที่เปลี่ยนคือตำแหน่งของฟิลด์เหล่านั้นและวิธีแนบเอกสาร ดู
Education สำหรับสคีมา v2 ฉบับเต็ม
API v1 POST /api/partner/v1/add/education.json
คัดลอก {
"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>"
}
}API v2 POST /api/partner/v2/add/requests/education.json
คัดลอก {
"credential_id": "seek-pass-test-a9a4839f-53d9-4064-8b0b-1348113a33f8",
"fields": {
"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
},
"assets": [
{
"asset_id": "open-cert-1",
"asset_type": "open_cert",
"asset_data": "<OPEN_CERTS>"
}
]
}การจับคู่ฟิลด์ id เปลี่ยนเป็น credential_id การตอบกลับสถานะใช้ credential_id เช่นกัน
credential_type ถูกนำออกจากเนื้อหาคำขอ ประเภทข้อมูลรับรองเป็นส่วนหนึ่งของ URL
data.credential เปลี่ยนเป็น fields
document_type และ data.document เปลี่ยนเป็นรายการ assets ที่มี asset_id, asset_type และ asset_data สำหรับ OpenCert ค่า asset_type คือ open_cert และ asset_data คือเนื้อหา OpenCert สำหรับ URL ของ PDF ค่า asset_type คือ pdf และ asset_data คือ URL
เมื่อ v1 ใช้ document_type เป็น none ให้ละเว้น assets
การตอบกลับเมื่อสร้างสำเร็จยังคงมี redirect_uri และมี asset_uploads ด้วย อาร์เรย์นั้นจะว่างเมื่อส่ง asset_data มาในคำขอ