Ini adalah dokumentasi untuk metode Personalization Handshake. Autentikasi menawarkan serangkaian metode Handshake yang berbeda.

Sebelum pengguna Anda dapat mengakses konten yang dipersonalisasi, mereka harus diautentikasi. Mintlify mendukung tiga metode Personalization Handshake:

  1. Shared Session: Memanfaatkan token sesi yang sama yang digunakan oleh dashboard Anda untuk mengautentikasi pengguna.
  2. JWT: Gunakan alur login Anda sendiri untuk mengirim info pengguna ke dokumentasi Anda melalui JWT dalam URL.
  3. OAuth 2.0: Integrasikan dengan server OAuth Anda untuk mengaktifkan login pengguna melalui alur PKCE.

​
Prasyarat

  • Anda memiliki dashboard atau portal pengguna lain yang di-host di domain Anda.
  • Kredensial sesi pengguna Anda disimpan sebagai cookie.
  • Anda dapat membuat endpoint API baru di origin yang sama atau subdomain dashboard Anda.
    • Jika dashboard Anda berada di foo.com, API URL harus dimulai dengan foo.com atau *.foo.com
    • Jika dashboard Anda berada di dash.foo.com, API URL harus dimulai dengan dash.foo.com atau *.dash.foo.com
  • Dokumentasi Anda di-host di domain yang sama dengan dashboard Anda.
    • Jika dashboard Anda berada di foo.com, docs harus dihosting di foo.com atau *.foo.com
    • Jika dashboard Anda berada di *.foo.com, docs Anda harus dihosting di foo.com atau *.foo.com

​
Kelebihan & Kekurangan

Pros:

  • Pengguna yang sudah login ke dashboard Anda secara otomatis login ke docs Anda
  • Sesi pengguna Anda bersifat persisten, artinya Anda dapat menyegarkan data tanpa memerlukan login tambahan
  • Pengaturan minimal diperlukan

Cons:

  • Docs Anda akan membuat permintaan ke backend Anda, yang mungkin tidak diinginkan
  • Anda harus memiliki dashboard yang menggunakan autentikasi sesi
  • Konfigurasi CORS biasanya diperlukan