Otorisasi API menetapkan hubungan antara aplikasi dan API. Aplikasi merupakan identitas yang digunakan untuk memanggil API dan harus diotorisasi terlebih dahulu sebelum dapat memanggil API tersebut.
Prasyarat
Metode autentikasi API diatur ke Alibaba Cloud App authentication.
Aplikasi
Aplikasi adalah identitas yang digunakan untuk memanggil API. Secara default, setiap aplikasi memiliki pasangan kunci yang terdiri dari AppKey dan AppSecret. AppKey harus diteruskan sebagai parameter dalam header permintaan, sedangkan AppSecret digunakan untuk menghitung signature permintaan. Untuk informasi lebih lanjut tentang cara menghitung dan meneruskan signature, lihat Gunakan autentikasi digest untuk memanggil API.
-
Pasangan kunci AppKey dan AppSecret memberikan izin penuh kepada aplikasi. Simpan secara aman. Jika pasangan kunci ini dikompromikan, Anda dapat meresetnya di Konsol API Gateway.
-
Anda dapat membuat beberapa aplikasi dan mengotorisasi masing-masing untuk memanggil API yang berbeda sesuai kebutuhan bisnis Anda. Perlu diperhatikan bahwa otorisasi API diberikan kepada aplikasi, bukan kepada Akun Alibaba Cloud.
-
Di Konsol API Gateway, Anda dapat membuat, mengubah, dan menghapus aplikasi, melihat detail, mengelola kunci, serta melihat daftar API yang telah diotorisasi.
-
Anda dapat menambahkan pasangan AppKey dan AppSecret baru ke suatu aplikasi dari halaman detailnya. Pasangan kunci baru tersebut memiliki semua izin aplikasi dan dapat dihapus. Pasangan kunci default yang dibuat saat pembuatan aplikasi tidak dapat dihapus.
Buat aplikasi
-
Masuk ke Konsol API Gateway. Di panel navigasi sebelah kiri, pilih , lalu klik Create App di pojok kanan atas.
-
Di halaman Create App, masukkan App Name dan klik Create.
Saat membuat aplikasi, Anda dapat secara opsional mengatur tag, menyediakan informasi AK kustom, dan mengonfigurasi extension field.
-
Tag settings: Gunakan tag untuk mengelompokkan aplikasi Anda.
-
Custom AK information: Memungkinkan Anda menentukan AppKey dan AppCode kustom saat membuat aplikasi. Anda juga dapat mengubah AppKey dan AppCode aplikasi yang sedang berjalan di produksi. Perubahan tersebut berlaku langsung.
-
Extension field: Memungkinkan Anda mengonfigurasi bidang ekstensi untuk aplikasi. API Gateway meneruskan bidang ini ke layanan backend sebagai parameter sistem
CaAppExtInfo.PentingUntuk instans khusus yang dibeli sebelum Agustus 2023, jika bidang ekstensi tidak berfungsi, kirimkan tiket untuk melakukan upgrade versi instans Anda.
Nonaktifkan aplikasi
-
Masuk ke Konsol API Gateway. Di panel navigasi sebelah kiri, pilih .
-
Klik aplikasi yang dituju untuk membuka halaman Application Details. Lalu, klik Disable App Authentication di pojok kanan atas.
CatatanSetelah dinonaktifkan, aplikasi tidak dapat lagi memanggil API yang telah diotorisasi. Anda dapat mengaktifkan kembali aplikasi tersebut kapan saja untuk melanjutkan pemanggilan API.
PentingUntuk instans khusus yang dibeli sebelum Juli 2025, jika fitur ini tidak berfungsi, kirimkan tiket untuk melakukan upgrade versi instans Anda.
Otorisasi API
Otorisasi adalah proses pemberian izin kepada aplikasi untuk memanggil API. Aplikasi harus diotorisasi terlebih dahulu sebelum dapat memanggil API.
-
Anda dapat langsung mengotorisasi aplikasi milik Anda sendiri untuk memanggil API Anda.
-
Anda dapat mengotorisasi aplikasi Anda untuk memanggil API yang Anda beli dari Alibaba Cloud Marketplace. Jika Anda belum memiliki aplikasi, Alibaba Cloud Marketplace akan membuatkan satu untuk Anda dan mengotorisasikannya selama proses pembelian. Untuk informasi lebih lanjut, kunjungi Konsol Alibaba Cloud Marketplace.
-
Untuk menggunakan API mitra (dari Akun Alibaba Cloud lain) melalui perjanjian offline, buat aplikasi dan berikan ID aplikasi tersebut kepada mitra Anda. Mitra tersebut kemudian dapat mengotorisasi aplikasi Anda dengan mencari ID-nya.
Prosedur
-
Masuk ke Konsol API Gateway. Di panel navigasi sebelah kiri, pilih , temukan API yang dituju, lalu di kolom Actions, klik
> Authorize. -
Di halaman otorisasi, pilih stage dan Authorization validity period, lalu pilih aplikasi yang akan diotorisasi di bawah Choose apps for authorization. Untuk mengotorisasi aplikasi dalam akun Anda, pilih My apps dan klik Search untuk memuat semua aplikasi dalam akun Anda.
Untuk mengotorisasi aplikasi dari akun lain, masukkan ID aplikasi yang sesuai di kotak teks, lalu klik Search.
PentingUntuk instans khusus yang dibeli sebelum November 2023, jika pasangan kunci yang baru ditambahkan tidak berlaku, kirimkan tiket untuk melakukan upgrade versi instans Anda. Pasangan kunci default yang dibuat saat pembuatan aplikasi tidak terpengaruh oleh versi instans.