Memulai
Sumber daya inti
Lainnya

Alihkan pengguna

Info
Ada perubahan penting baru-baru ini pada halaman ini, lihat catatan rilis untuk informasi lebih lanjut

Pengambilan detail permintaan

Ambil data permintaan yang sudah ada dari SEEK Pass menggunakan endpoint status atau bulk status. Endpoint ini mengembalikan informasi tentang satu atau beberapa permintaan, seperti statusnya, kapan permintaan tersebut difinalisasi, dan URI pengalihan untuk pengguna.
Ini adalah cara yang disarankan untuk mengarahkan pengguna yang sudah memiliki permintaan yang sudah ada agar menyelesaikan atau melihat pengajuan kredensial mereka di SEEK Pass. Mencoba untuk membuat permintaan baru guna menghasilkan URI pengalihan tidak disarankan.

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:

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"
Info
Kami menyarankan untuk menggunakan nilai yang unik secara global (mis. UUID) untuk id untuk memastikan pelacakan permintaan pengguna dengan benar.
Info
Saat memanggil endpoint ini dengan ID yang sudah ada, Anda harus mengetahui status permintaan yang sudah ada tersebut. ID yang terkait dengan permintaan yang sedang berlangsung akan ditolak, dan pengguna sebaiknya diarahkan untuk menyelesaikan pengajuan mereka di SEEK Pass dengan menggunakan endpoint status permintaan untuk mengambil URI yang relevan.
Caution
Untuk mengunggah file (PDF, JPG, PNG, dll.) yang dikirim sebagai URL di kolom dokumen, pastikan persyaratan berikut terpenuhi:
  1. 1.
    Akses publik: URL harus dapat diakses tanpa header tambahan atau autentikasi berbasis browser
  2. 2.
    Daftar izin domain: Domain harus dimasukkan ke daftar izin oleh SEEK Pass
Hubungi tim kami untuk meminta domain dimasukkan ke daftar putih.

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
Info
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 saat permintaan tertunda: Membuat permintaan dengan ID yang sudah ada kapan pun saat permintaan belum difinalisasi akan menghasilkan error. Selalu periksa status permintaan yang sudah ada dan tentukan apakah pengguna harus diarahkan ke permintaan yang sudah ada atau dibuatkan permintaan baru.
  • Asosiasi pengguna: Saat pengguna mengakses redirect_uri dan melakukan otentikasi, data kredensial menjadi terkait dengan akun mereka.
  • Kedaluwarsa Permintaan yang Belum Terkait: Jika pengguna gagal mengakses redirect_uri dan memulai pengajuan mereka dalam 48 jam, permintaan akan otomatis dibatalkan dan data asli akan dihapus secara permanen. Setelah titik ini, permintaan yang ada akan difinalisasi dan dibatalkan, dan Anda dapat menggunakan kembali ID yang sama untuk membuat permintaan baru yang akan dikirim kepada pengguna.
  • Kedaluwarsa Permintaan Terkait: Pengguna dapat mengakses redirect_uri, tetapi kemudian keluar dan tidak mengonfirmasi penambahan kredensial ke akun mereka. Pengguna memiliki waktu hingga 30 hari untuk kembali ke platform dan mengonfirmasi, tergantung pada jenis kredensial. Setelah periode ini, permintaan tersebut akan difinalisasi dan dibatalkan, dan Anda dapat menggunakan kembali ID yang sama untuk membuat permintaan baru yang dikirim kepada pengguna.
  • 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, saat pengguna mengakses redirect_uri yang sama, pengguna akan diarahkan ke kredensial yang telah mereka ajukan.
  • 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.
Info
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

Saat menerbitkan ulang kredensial, terlepas dari apakah kredensial tersebut berubah atau tidak, semua permintaan harus menggunakan kembali ID unik yang sama untuk merujuk ke kredensial yang sama. Menerbitkan ulang kredensial tidak dapat dilakukan saat permintaan saat ini sedang berlangsung.
Untuk memperbarui kredensial dengan isi baru, mitra harus mengirimkan permintaan baru dengan nilai yang sama untuk field tertentu yang digunakan dalam 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 yang lebih baru dari kredensial yang sama menggantikan yang sudah ada, bukan muncul sebagai kredensial baru, field 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
ChevronSebelumnya: Kedaluwarsa & pencabutan
Berikutnya: Periksa status pengajuanChevron