Alihkan pengguna

Pengajuan data

Kirim data pengguna ke SEEK Pass menggunakan endpoint yang benar berdasarkan tipe kredensial. Misalnya, untuk tipe kredensial Pendidikan, endpoint yang harus dipanggil adalah: /api/partner/v1/add/education.json.

Lingkungan

Endpoint environment staging dan production tersedia di bawah ini:

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

Contoh permintaan

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"

Kami menyarankan untuk menggunakan nilai yang unik secara global (mis. UUID) untuk id untuk memastikan pelacakan permintaan pengguna dengan benar.

Untuk mengunduh file (PDF, JPG, PNG, dll.) yang tertaut di kolom dokumen, pastikan persyaratan berikut terpenuhi:

1.
Public accessibility: File harus dapat diakses tanpa autentikasi
2.
Domain whitelisting: Domain Anda harus ditambahkan ke daftar izin firewall VPC SEEK Pass

Hubungi tim kami untuk meminta domain whitelisting.

Kode respons

201 Dibuat: Permintaan berhasil

{
    "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 format

Pengalihan URL dihasilkan dengan format ini:

Path: /partner/add/[CREDENTIAL TYPE]
Contoh:
- Untuk Pendidikan: /partner/add/education
- Untuk kemampuan berbahasa Inggris: /partner/add/englishProficiency
- Untuk Pembelajaran dan Pengembangan: /partner/add/microcredential
Hash: parameter di bawah ini, yang dikodekan sebagai parameter kueri URL
- clientId: ID klien OAuth mitra
- documentType: Tipe dokumen yang sesuai
- content: ID permintaan SEEK Pass

Catatan: CURL mengembalikan hasil yang tidak valid \u0026 alih-alih &. Harap ganti \u0026 dengan & dalam pengalihan URL. Klien lain seharusnya tidak mengalami masalah ini.

Perilaku

Penggunaan ulang ID dalam 48 jam: Mengajukan permintaan dengan ID yang sudah ada dalam 48 jam akan mengembalikan redirect_uri asli.
Penggunaan ulang ID setelah 48 jam: Setelah 48 jam, data asli dihapus secara permanen. Mengajukan ulang dengan ID yang sama membuat permintaan kredensial baru dengan ID SEEK Pass yang berbeda dan menghasilkan redirect_uri yang baru.
Asosiasi pengguna: Saat pengguna mengakses redirect_uri dan melakukan otentikasi, data kredensial menjadi terkait dengan akun mereka.
Alur persetujuan: Data kredensial terkait dengan akun pengguna saat otentikasi, terlepas dari status persetujuan. Jika persetujuan belum diberikan, redirect_uri akan meminta pengguna untuk menyetujui.
Perilaku setelah persetujuan: Setelah persetujuan diberikan, permintaan API berikutnya mengembalikan URL yang sama, mengarahkan pengguna ke kredensial yang telah diajukan.
Kebijakan retensi data: Jika pengguna menyelesaikan alur pengguna tetapi tidak mengunduh dan melakukan autentikasi melalui aplikasi seluler dalam 48 jam, semua dokumen terkait akan dihapus secara aman sesuai kebijakan perlindungan data.

Setelah pengguna mengklik tautan dan masuk ke sistem, data tersebut hanya terkait dengan pengguna tersebut. Jika pengguna lain mencoba menggunakan tautan yang sama, mereka akan diarahkan ke halaman error.

Memperbarui kredensial yang ada

Untuk memperbarui kredensial dengan versi baru dari kredensial yang sama, mitra harus mengajukan permintaan baru dengan nilai yang sama untuk kolom tertentu yang digunakan pada pengajuan awal.

Skenario ketika ini mungkin diperlukan mencakup:

Pengguna memperbarui kredensial karena kredensial yang asli akan segera kedaluwarsa
Pengguna mengulang kredensial berbasis penilaian dan telah menerima skor baru
Pengguna dengan Kualifikasi Pendidikan berstatus 'menunggu kelulusan' kini telah diberikan gelarnya

Agar versi terbaru dari kredensial yang sama dapat menggantikan yang sudah ada, kolom berikut harus tetap sama:

Education: course_name, conferral_year, majors (jika berlaku), with_honours (jika berlaku)
English Proficiency: test_name, test_provider
Learning and Development: microcredential_name, issuer_name

Ini akan membuat permintaan Add to SEEK Pass baru yang harus dikirim ke pengguna, sehingga pengguna dapat memperbarui informasi kredensial mereka.

Sebelumnya: Kedaluwarsa & pencabutan

Berikutnya: Periksa status pengajuan