Fitur otorisasi API digunakan untuk memberikan izin kepada aplikasi agar dapat memanggil API. Aplikasi merupakan identitas yang digunakan untuk memanggil API. Sebelum digunakan, aplikasi harus diberi otorisasi.
Prasyarat
Metode autentikasi API adalah Alibaba Cloud App.
Aplikasi
Aplikasi adalah identitas yang digunakan untuk memanggil API. Setiap aplikasi memiliki sepasang kunci berupa AppKey dan AppSecret. Saat menggunakan aplikasi untuk memanggil API, AppKey harus ditentukan sebagai header dalam permintaan, dan AppSecret digunakan untuk menghitung string tanda tangan yang dilampirkan pada permintaan. Untuk informasi lebih lanjut tentang cara menghitung dan meneruskan tanda tangan, lihat Gunakan autentikasi digest untuk memanggil API.
Siapa pun yang mendapatkan pasangan AppKey dan AppSecret sebuah aplikasi memiliki semua izin terhadap aplikasi tersebut. Pastikan kerahasiaan pasangan AppKey dan AppSecret. Jika Anda secara tidak sengaja membocorkan pasangan ini, Anda dapat menyetel ulangnya di konsol API Gateway.
Anda dapat membuat beberapa aplikasi dan mengotorisasi masing-masing untuk memanggil API yang berbeda sesuai kebutuhan. Perlu diperhatikan bahwa hanya aplikasi—bukan Akun Alibaba Cloud—yang dapat diotorisasi untuk memanggil API.
Di konsol API Gateway, Anda dapat membuat, memodifikasi, atau menghapus aplikasi, melihat detail aplikasi, mengelola pasangan kunci, serta melihat API yang diizinkan untuk dipanggil oleh aplikasi.
Anda dapat menambahkan pasangan AppKey dan AppSecret baru ke aplikasi dan melihat pasangan kunci yang telah ditambahkan di halaman detail aplikasi. Setiap pasangan kunci baru memiliki semua izin terhadap aplikasi. Jika Anda tidak lagi memerlukan pasangan kunci yang telah ditambahkan, Anda juga dapat menghapusnya. Namun, Anda tidak dapat menghapus pasangan kunci default aplikasi, yang dibuat saat aplikasi dibuat.
Create an application
Masuk ke Konsol API Gateway. Di panel navigasi sebelah kiri, pilih , lalu klik Create App di pojok kanan atas.
Di kotak dialog Create App, konfigurasikan parameter App Name lalu klik Konfirmasi.
Saat membuat aplikasi, Anda dapat secara opsional mengatur tag aplikasi, menyesuaikan Informasi AccessKey, dan mengonfigurasi Extension Fields.
Set Tags: Gunakan tag untuk menandai aplikasi.
Custom AccessKey Information: Anda dapat membuat pasangan AccessKey dan AppCode khusus untuk aplikasi tersebut. Pasangan ini juga dapat dimodifikasi setelah aplikasi dibuat, dan perubahan tersebut langsung berlaku.
Extension Fields: Anda dapat mengonfigurasi bidang tambahan untuk aplikasi tersebut. Sistem akan meneruskan bidang tambahan ini sebagai parameter sistem bernama CaAppExtInfo ke layanan backend.
PentingUntuk instance khusus yang dibeli sebelum Agustus 2023, jika bidang ekstensi tidak berlaku, Anda harus mengirimkan tiket untuk meningkatkan instance Anda.
Disable an application
Masuk ke Konsol API Gateway. Di panel navigasi sebelah kiri, pilih .
Klik aplikasi target untuk membuka halaman Application Details, lalu klik Disable App Authentication di pojok kanan atas.
CatatanSetelah aplikasi dinonaktifkan, API yang diotorisasi untuk aplikasi tersebut tidak dapat dipanggil oleh aplikasi tersebut. Setelah diaktifkan kembali, aplikasi dapat melanjutkan pemanggilan API.
PentingUntuk Instans khusus yang dibeli sebelum Juli 2025, jika fitur nonaktifkan aplikasi tidak berlaku, Anda harus mengajukan Tiket untuk meningkatkan instans Anda.
Otorisasi API
Aplikasi harus diberi otorisasi sebelum dapat digunakan untuk memanggil API. Hanya aplikasi yang diberi otorisasi yang dapat memanggil API.
Jika Anda membuat aplikasi dan API sendiri, Anda dapat memberi otorisasi aplikasi untuk memanggil API langsung di konsol.
Jika Anda membeli API dari Alibaba Cloud Marketplace, Anda dapat mengotorisasi aplikasi Anda untuk memanggil API yang telah dibeli. Jika belum memiliki aplikasi, Alibaba Cloud Marketplace akan membuat aplikasi yang telah diotorisasi untuk Anda selama proses pembelian. Untuk informasi lebih lanjut, kunjungi Konsol Alibaba Cloud Marketplace.
Jika Anda ingin memanggil API milik Akun Alibaba Cloud lain, otorisasi API harus dilakukan oleh akun tersebut—yang juga dikenal sebagai penyedia API. Anda harus membuat aplikasi dan memberikan ID aplikasi tersebut kepada penyedia API. Selanjutnya, penyedia API dapat menemukan aplikasi Anda berdasarkan ID tersebut dan mengotorisasi aplikasi Anda untuk memanggil API tersebut.
Procedure
Masuk ke Konsol API Gateway. Di panel navigasi sebelah kiri, pilih , lalu pilih kolom Actions >
> Authorize untuk API tersebut.
Di halaman otorisasi, pilih Select The Environment To Authorize, Authorization Validity Period, dan Select The Application To Authorize. Di bagian My Apps, klik Search untuk memuat secara otomatis semua aplikasi di bawah akun Anda.
Jika Anda ingin memberi otorisasi aplikasi yang dimiliki oleh akun lain, pilih ID Aplikasi dari daftar drop-down Pilih Aplikasi untuk Otorisasi, masukkan ID aplikasi, dan klik Cari. Aplikasi tersebut akan ditampilkan.
PentingJika instance khusus Anda dibeli sebelum November 2023 dan pasangan kunci baru yang ditambahkan ke aplikasi tidak berlaku, Anda harus mengirimkan tiket untuk meningkatkan instance Anda. Pasangan kunci default yang dibuat saat aplikasi dibuat tidak terpengaruh oleh batasan versi.