Memulai
Sumber daya inti
Lainnya

Alur integrasi Tambah ke SEEK Pass

Info
Ada perubahan penting baru-baru ini pada halaman ini, lihat catatan rilis untuk informasi lebih lanjut
Integrasi Tambahkan ke SEEK Pass mengikuti alur standar untuk mengirimkan data kredensial secara aman dari sistem mitra ke SEEK Pass. Diagram urutan ini menggambarkan proses lengkapnya.

Alur integrasi

Mitra menyiapkan data pengguna untuk payload dalam format JSON berdasarkan jenis kredensial (misalnya kualifikasi pendidikan atau kemampuan bahasa Inggris). Persyaratan detail disediakan untuk setiap jenis kredensial di bagian masing-masing.
Proses integrasi melibatkan langkah-langkah utama berikut:
  1. 1.
    Siapkan data dalam format JSON sesuai spesifikasi tipe kredensial
  2. 2.
    Autentikasi dengan SEEK Pass untuk mengambil token akses OAuth
  3. 3.
    Periksa apakah sudah ada permintaan untuk menentukan apakah perlu membuat permintaan baru atau menggunakan kembali permintaan yang sudah ada
  4. 4.
    1. a.
      Jika tidak menggunakan kembali permintaan yang sudah ada, kirim data pengguna untuk menerima URL pengalihan
    2. b.
      Jika menggunakan kembali permintaan yang sudah ada, gunakan URL pengalihan yang dikembalikan dari detail permintaan yang diambil
  5. 5.
    Arahkan pengguna ke URL redirect yang diberikan untuk pengalaman yang mulus
  6. 6.
    (Opsional) Periksa status pengajuan untuk memverifikasi apakah pengajuan berhasil, dibatalkan, atau masih sedang berlangsung

Representasi visual

Diagram di bawah ini menggambarkan alur data antara sistem mitra, API SEEK Pass, dan pengguna akhir:

Perjalanan integrasi

Alur kerja integrasi terdiri dari dua fase utama, otentikasi dan pengajuan data pengguna:

Otentikasi menggunakan OAuth

Mulailah dengan melakukan autentikasi dengan SEEK Pass menggunakan OAuth 2.0.
Anda akan menerima client ID dan client secret saat mendaftar sebagai mitra dengan SEEK Pass.
Gunakan kredensial ini dengan Authentication API untuk mendapatkan token akses OAuth untuk panggilan API selanjutnya.

Pengajuan Data

Setelah terautentikasi, pastikan Anda memeriksa catatan Anda sendiri untuk setiap permintaan yang sudah ada yang mungkin sudah dibuat untuk kredensial ini. Penerbitan ulang kredensial yang sama hanya diizinkan jika permintaan yang sudah ada sudah difinalisasi, jika tidak error akan dikembalikan.
Jika Anda memiliki catatan tentang permintaan yang sudah ada untuk pengguna dan kredensial yang sama yang sedang diterbitkan, panggil endpoint yang sesuai untuk mengambil detail permintaan dari Add to SEEK Pass API. Jika permintaan yang sudah ada belum difinalisasi, arahkan pengguna ke URL yang diberikan dari detail permintaan yang sudah ada untuk menyelesaikan proses di SEEK Pass dengan lancar.
Jika tidak ada permintaan yang sudah ada, atau jika permintaan yang sudah ada sudah difinalisasi, siapkan data pengguna Anda dalam format JSON sesuai dengan spesifikasi jenis kredensial yang relevan, seperti Kualifikasi Pendidikan. Kemudian, kirimkan data ini melalui Add to SEEK Pass API, dan gunakan URL yang diberikan untuk mengarahkan pengguna menyelesaikan proses di SEEK Pass dengan lancar.
Anda juga dapat memantau submission status secara opsional untuk melacak apakah prosesnya berhasil, dibatalkan, atau masih sedang berlangsung.

Perjalanan pengguna

  1. 1.
    Pengguna masuk ke alur: Pengguna mengklik tautan / memasukkan kode yang disediakan mitra (misalnya, melalui kode / tombol di email).
  2. 2.
    Validasi data: Pengguna diarahkan ke API mitra untuk validasi data.
  3. 3.
    Pembuatan tautan permintaan: Mitra memanggil API SEEK Pass untuk mengambil dan/atau membuat permintaan yang akan mengembalikan URL pengalihan. Mitra dapat secara opsional menampilkan halaman pemuatan selama periode ini.
  4. 4.
    Pengalihan pengguna: Browser pengguna kemudian dialihkan oleh mitra ke URL yang diberikan untuk menambahkan kredensial ke SEEK Pass
  5. 5.
    Proses verifikasi: Pengguna dipandu melalui alur singkat yang lancar untuk menambahkan kredensial mereka ke SEEK Pass

Implementasi teknis

Untuk detail implementasi teknis, lihat bagian-bagian berikut:

Praktik terbaik

Untuk hasil integrasi yang optimal:
  • Selalu validasi data payload sebelum pengajuan
  • Selalu periksa permintaan yang sudah ada untuk memahami kapan harus membuat dan kapan harus menggunakan kembali permintaan yang sudah ada
  • Jangan ubah ID yang sudah ada untuk kredensial yang sama. Menerbitkan ulang kredensial yang sama dengan ID yang berbeda dalam beberapa keadaan dapat menyebabkan kredensial tersebut ditambahkan ke akun pengguna beberapa kali. Terutama, hindari membuat ID baru setiap kali pengguna mengklik tombol Tambahkan ke SEEK Pass
  • Terapkan penanganan kesalahan yang tepat untuk respons API
  • Sediakan halaman pemuatan bermerek selama panggilan API
  • Ikuti panduan merek SEEK Pass untuk penempatan dan desain tombol

Otentikasi Email OTP – Pertimbangan Domain Mitra

Jika organisasi Anda menggunakan domain email kustom (misalnya @youruniversity.edu.sg), pastikan email OTP (One-Time Password) dari SEEK Pass berhasil terkirim ke akun Anda.
Yang perlu diperiksa
  • Gunakan alamat email asli dari domain Anda untuk menguji alur OTP
  • Pastikan email OTP tidak diblokir oleh firewall email atau filter spam organisasi Anda
  • Pastikan pengguna dapat menyelesaikan proses masuk atau verifikasi menggunakan OTP yang diterima
  • Jika Anda tidak dapat menerima email OTP selama pengujian, hubungi tim IT Anda untuk mengizinkan email dari @seek.com.au, @seekpass.co, @seekpass-staging.com (lingkungan staging untuk tujuan pengujian), atau hubungi kontak integrasi SEEK Pass Anda
ChevronSebelumnya: Cabut token OAuth
Berikutnya: Definisi kredensialChevron