Anda dapat memberikan izin kepada ruang kerja lain untuk memanggil API setelah menerbitkannya atau melihat API yang telah diberikan izin kepada ruang kerja Anda untuk dipanggil guna mengimplementasikan berbagi data. Topik ini menjelaskan cara memberikan izin yang diperlukan untuk memanggil API dalam berbagai skenario.
Prasyarat
Anda hanya dapat membatalkan penerbitan, memberikan akses otorisasi, atau mengubah protokol API setelah API tersebut diterbitkan. Untuk informasi selengkapnya, lihat Pengujian, penerbitan, dan manajemen versi API.
Buka halaman Manage APIs
-
Masuk ke Konsol DataWorks. Di Wilayah target, klik di panel navigasi kiri. Pilih ruang kerja dari daftar drop-down dan klik Go to DataService Studio.
-
Di bilah menu atas, klik Service Management untuk membuka halaman Manage APIs.
Berikan izin untuk memanggil API
-
Di tab Published APIs, temukan API yang diinginkan dan klik Authorization.
-
Di kotak dialog API Authorization, konfigurasikan parameter.
Setelah Anda memberikan otorisasi, anggota ruang kerja target dapat melihat API tersebut di tab Manage APIs > APIs Authorized for Me dan memanggilnya menggunakan AppCode atau AppKey dan AppSecret milik ruang kerja mereka. Untuk mengelola atau mencabut otorisasi, buka tab Manage APIs > APIs I Have Authorized dan klik Manage Authorization. Untuk menambahkan kredensial lain, buka Konsol API Gateway, navigasikan ke Call API > Application Management, buat aplikasi baru, lalu berikan otorisasi. Catatan: Jika Anda membatalkan penerbitan atau menghapus API, otorisasi yang ada akan menjadi tidak valid. Lakukan tindakan ini dengan hati-hati.
Parameter
Deskripsi
API Name
Nama API yang ingin Anda berikan izin pemanggilannya kepada suatu ruang kerja. Anda tidak dapat mengubah nilai parameter ini.
Tenant Account ID
ID Akun Alibaba Cloud yang akan diberikan izin untuk memanggil API. Anda dapat melihatnya di halaman Security Settings.
Authorized Workspace
Nama ruang kerja yang akan diberikan izin untuk memanggil API. Anda dapat memilih ruang kerja yang termasuk dalam Akun Alibaba Cloud saat ini dari daftar drop-down.
Authorization Validity Period
Periode validitas izin pemanggilan API. Nilai yang valid adalah Limited dan Unlimited.
-
Limited: Anda harus memilih tanggal kedaluwarsa. API dapat dipanggil hingga tanggal tersebut.
-
Unlimited: Setelah Anda memilih Unlimited, Anda akan memiliki izin permanen untuk memanggil API tersebut.
-
-
Klik Confirm.
Di tab Published APIs, Anda juga dapat melakukan operasi berikut:
-
Klik Unpublish di samping API. Di kotak dialog Unpublish API, klik Confirm.
Catatan-
Jika Anda membatalkan penerbitan atau menghapus API setelah memberikan izin kepada ruang kerja untuk memanggil API tersebut, ruang kerja tersebut tidak dapat lagi memanggil API tersebut.
-
Jika Anda menerbitkan ulang API setelah membatalkan penerbitan atau memodifikasi API, Anda harus memberikan kembali izin kepada ruang kerja terkait untuk memanggil API tersebut.
-
-
Klik Test di samping API untuk membuka halaman API Test. Untuk informasi selengkapnya, lihat Uji API.
-
Arahkan kursor ke More di samping API dan klik Change Protocol. Di kotak dialog Change Protocol, atur protokol API baru dan klik Confirm.
Catatan-
Jika Anda menghapus protokol, API tidak dapat lagi dipanggil menggunakan protokol tersebut. Lakukan operasi ini dengan hati-hati.
-
Perubahan protokol berlaku secara real time.
-
-
Lihat API yang diberikan izin kepada ruang kerja Anda untuk dipanggil
Di halaman Manage APIs, klik tab Authorized to Use untuk melihat semua API yang telah diotorisasi untuk Anda.
Anda dapat melakukan operasi berikut pada API yang diberikan izin kepada ruang kerja Anda untuk dipanggil:
-
Klik Test di samping API untuk membuka halaman API Test. Untuk informasi selengkapnya, lihat Uji API.
-
Klik Delete di samping API. Di kotak dialog Delete authorized, klik Confirm.
Lihat API yang Anda berikan izin kepada ruang kerja lain untuk dipanggil
Di halaman Manage APIs, klik tab Authorize Others to Use untuk melihat semua API yang telah Anda otorisasi untuk pihak lain.
Anda dapat melakukan operasi berikut pada API yang Anda berikan izin kepada ruang kerja lain untuk dipanggil:
-
Klik Test di samping API untuk membuka halaman API Test. Untuk informasi selengkapnya, lihat Uji API.
-
Klik Manage di samping API. Di kotak dialog Authorization, Anda dapat mencabut atau memodifikasi otorisasi untuk suatu ruang kerja.
Fitur otorisasi API
Fitur otorisasi API digunakan untuk memberikan izin kepada aplikasi agar dapat memanggil API. Aplikasi merupakan identitas yang digunakan untuk memanggil API. Untuk memanggil API, Anda harus memberikan izin kepada aplikasi tersebut. Secara default, Alibaba Cloud APP yang didukung oleh DataWorks DataService Studio digunakan untuk otentikasi identitas pengguna selama pemanggilan API dalam suatu ruang kerja. DataWorks DataService Studio memberikan izin kepada aplikasi yang memiliki nama sama dengan ruang kerja untuk memanggil API dalam ruang kerja tersebut. Dalam kasus ini, pemanggil dapat menggunakan AppCode, AppKey, dan AppSecret aplikasi tersebut untuk memanggil API secara aman. Untuk informasi selengkapnya, lihat Panggil API.
Saat memanggil API, Anda mungkin menghadapi isu tertentu, seperti cara mengidentifikasi dan membedakan sumber pemanggilan serta cara mengalokasikan informasi otentikasi secara tepat untuk mengotentikasi pemanggilan. Bagian ini menjelaskan cara memberikan izin untuk memanggil API DataService Studio pada tingkat granularitas berbeda dalam berbagai skenario sesuai kebutuhan bisnis Anda.
Skenario 1: Anggota dalam ruang kerja DataWorks menggunakan aplikasi yang sama untuk memanggil API
Skenario 2: Setiap Pengguna RAM menggunakan aplikasi terpisah milik Pengguna RAM tersebut untuk memanggil API
Skenario 3: Pengguna RAM dalam kelompok yang sama menggunakan aplikasi yang sama untuk memanggil API
