Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi
Apigee X. info
Selamat datang di halaman beranda untuk OAuth di Apigee Edge. Halaman landing ini menyediakan link ke dokumentasi, contoh, dan referensi lainnya yang terkait dengan penggunaan OAuth di Apigee Edge.
Framework OAuth 2.0
Amankan API Anda dengan OAuth 2.0. Bagian ini mencantumkan referensi, contoh kode, video, dan topik lainnya untuk membantu Anda berhasil menggunakan OAuth 2.0 di Apigee Edge.
Pelajari OAuth 2.0
Kumpulan referensi ini akan membantu Anda memahami OAuth 2.0.
-
Dokumentasi Apigee:
- Pengantar OAuth 2.0 -- Mencakup konsep dan istilah dasar OAuth 2.0. Berfokus menggunakan OAuth di Apigee Edge.
- Pelatihan dan sertifikasi Apigee:
- Apigee menawarkan pelatihan online untuk developer API, termasuk kursus tentang keamanan API, yang mencakup OAuth.
-
Spesifikasi IETF:
- Spesifikasi IETF -- Apigee sangat merekomendasikan agar Anda meninjau spesifikasi ini. Panduan ini mencakup pengantar dasar yang baik dan ringkasan konseptual.
-
E-book dan video Apigee:
- OAuth the Big Picture, e-book gratis Apigee.
- OAuth the Big Picture, webcast Apigee gratis.
Mengimplementasikan alur jenis pemberian akses
Apigee menyediakan contoh yang berfungsi dari setiap jenis pemberian OAuth 2.0 untuk membantu Anda memulai. Contoh ini mewakili praktik terbaik dan menunjukkan cara menerapkan jenis pemberian OAuth di Apigee Edge.
Kredensial klien
- Menerapkan jenis pemberian kredensial klien - Memperkenalkan jenis pemberian, dengan penekanan pada langkah-langkah yang perlu Anda ikuti untuk menerapkan jenis pemberian ini di Apigee Edge.
- Contoh implementasi -- Lihat contoh ini di repo contoh API kami di GitHub.
- Keamanan API (termasuk OAuth)
Kode otorisasi
- Menerapkan jenis pemberian kode otorisasi -- Memperkenalkan jenis pemberian, dengan penekanan pada langkah-langkah yang perlu Anda ikuti untuk menerapkan jenis pemberian ini di Apigee Edge.
- Contoh penerapan -- Lihat contoh lanjutan ini di repo contoh API kami di GitHub. Anda dapat meng-clone contoh, men-deploynya, dan menjalankannya. Untuk mengetahui detailnya, lihat file README. Library ini mencakup aplikasi login yang andal yang mengautentikasi pengguna dan berkomunikasi dengan aman dengan server otorisasi.
Implisit
- Meminta token: Jenis pemberian implisit -- Menunjukkan cara meminta token dengan jenis pemberian implisit.
Kredensial sandi pemilik resource
- Menerapkan jenis pemberian sandi -- Memperkenalkan jenis pemberian, dengan penekanan pada langkah-langkah yang perlu Anda ikuti untuk menerapkan jenis pemberian ini di Apigee Edge.
Topik cara cepat
Topik ini memberi Anda konteks cepat dan langkah-langkah ringkas untuk menangani tugas OAuth 2.0 umum:
- Mengonfigurasi proxy API baru
- Mendaftarkan aplikasi klien
- Memperoleh kredensial klien
- Mengonfigurasi endpoint dan kebijakan OAuth
- Meminta token dan kode autentikasi
- Menyesuaikan token akses
- Menyetujui dan mencabut token akses
- Mengirim token akses
- Memverifikasi token akses
- Menggunakan cakupan
- Topik lanjutan
Referensi API dan kebijakan
Topik ini memberikan informasi referensi mendetail tentang kebijakan dan API yang secara langsung mendukung OAuth 2.0 di Edge.
-
Kebijakan OAuthV2 -- Kebijakan ini memungkinkan Anda menerapkan dan menyesuaikan empat jenis pemberian OAuth 2.0 di Apigee Edge:
- Kebijakan OAuthV2 -- Inti dari penerapan OAuth 2.0 Apigee Edge. Dengan API ini, Anda dapat mengonfigurasi "operasi" OAuth 2.0 di Apigee Edge yang menghasilkan token akses dan token refresh, menerbitkan kode otorisasi, dan memvalidasi token. Topik ini mencakup contoh kode untuk membantu menggambarkan cara kerjanya.
- Kebijakan GetOAuthV2Info -- Mendapatkan atribut token dan menyediakannya untuk kebijakan dan kode yang dijalankan di proxy API. Jenis kebijakan ini dapat berguna saat Anda perlu mengonfigurasi perilaku dinamis dan kondisional berdasarkan nilai dalam token akses. Lihat juga Menyesuaikan token akses.
- Kebijakan SetOAuthV2Info -- Memperbarui profil token akses. Misalnya, Anda mungkin ingin menyematkan tag yang unik untuk bisnis Anda. Lihat juga Menyesuaikan token akses.
- Kode error OAuth 2.0
- OAuth 2.0 API -- Apigee menyediakan API ini untuk digunakan dengan endpoint OAuth 2.0.
Framework OAuth 1.0a
OAuth 1.0a menentukan protokol standar yang memungkinkan pengguna aplikasi memberikan otorisasi kepada aplikasi untuk menggunakan API atas nama mereka, tanpa mengharuskan pengguna aplikasi mengungkapkan sandi mereka ke aplikasi dalam prosesnya.
Referensi kebijakan OAuth 1.0a
Referensi kebijakan OAuthV1 menjelaskan cara mengonfigurasi kebijakan OAuth v1.0a. Jenis kebijakan OAuthV1 bertanggung jawab untuk membuat token permintaan, membuat token akses, dan memverifikasi token akses berdasarkan spesifikasi OAuth 1.0a.
API OAuth 1.0a
Apigee menyediakan API untuk menggunakan endpoint OAuth 1.0a.
Contoh OAuth 1.0a di GitHub
Contoh proxy API di GitHub ini mengilustrasikan konfigurasi tiga kaki OAuth 1.0a. Anda dapat mendownload dan menjalankan kode ini.
Nama | Deskripsi |
---|---|
oauth10a-3legged | Menunjukkan konfigurasi three-legged OAuth 1.0a. |