Ini adalah dokumentasi untukPersonalisasi OAuth Handshake. Langkah-langkah untuk menyiapkanOAuthAutentikasi Handshake sedikit berbeda.

Jika Anda memiliki server OAuth yang sudah ada yang mendukung alur PKCE, Anda dapat berintegrasi dengan Mintlify untuk pengalaman login yang mulus.

​
Implementasi

1

Buat API Info Anda

Buat endpoint API yang dapat diakses dengan token akses OAuth, dan merespons dengan payload JSON mengikuti formatUser. Perhatikan scope atau scope yang diperlukan untuk mengakses endpoint ini.

2

Konfigurasi pengaturan Personalisasi Anda

Pergi kepengaturan dashboard, pilih opsi OAuth, dan isi bidang yang diperlukan:

  • URL Otorisasi: URL dasar untuk permintaan otorisasi, yang akan kami tambahkan parameter query yang sesuai.
  • ID Klien: ID untuk klien OAuth 2.0 yang akan digunakan.
  • Scope: Array scope yang akan diminta.
  • URL Token: URL dasar untuk permintaan pertukaran token.
  • URL API Info: Endpoint yang akan diakses untuk mengambil info pengguna.
3

Konfigurasi klien OAuth Anda

Salin URL Pengalihan yang tercantum dipengaturan dashboard dan tambahkan sebagai URL pengalihan yang diizinkan untuk server OAuth Anda.

​
Contoh

Saya memiliki server OAuth yang sudah ada yang mendukung alur PKCE. Saya ingin menyiapkan autentikasi untuk dokumentasi saya yang di-host difoo.com/docs.

Untuk menyiapkan autentikasi dengan Mintlify, saya membuat endpointapi.foo.com/docs/user-info yang memerlukan token akses OAuth dengan scopedocs-user-info, dan merespons dengan data kustom pengguna sesuai dengan spesifikasi Mintlify.

Kemudian saya pergi ke pengaturan dashboard, navigasi ke pengaturan Personalisasi, pilih OAuth, dan masukkan nilai-nilai yang relevan untuk alur OAuth dan endpoint API Info:

  • URL Otorisasi:https://auth.foo.com/authorization
  • ID Klien:ydybo4SD8PR73vzWWd6S0ObH
  • Scope:['docs-user-info']
  • URL Token:https://auth.foo.com/exchange
  • URL API Info:https://api.foo.com/docs/user-info

Akhirnya, saya menyalin URL Pengalihan yang ditampilkan di pengaturan dashboard dan menambahkannya sebagai URL pengalihan yang diizinkan dalam pengaturan konfigurasi klien OAuth saya.