API Gateway：Gunakan SDK untuk Memanggil API

Ikhtisar

SDK yang dihasilkan secara otomatis di API Gateway terintegrasi dengan mekanisme tanda tangan. Dengan mekanisme ini, Anda tidak perlu menghitung tanda tangan secara manual. Jika Anda ingin menghitung tanda tangan di sisi klien, lihat Gunakan autentikasi digest untuk memanggil API.

Untuk informasi tentang persiapan sebelum memanggil API, lihat Gunakan API Gateway untuk mengakses layanan backend HTTP. API yang ingin Anda panggil menggunakan SDK harus memenuhi kondisi berikut:

• API menggunakan metode sertifikasi keamanan Alibaba Cloud App.

• Aplikasi tersebut telah diberi otorisasi untuk memanggil API.

• API diterbitkan ke lingkungan produksi.

1. Unduh SDK

Anda dapat menggunakan salah satu dari metode berikut untuk mengunduh SDK di konsol API Gateway:

Metode 1 Di panel navigasi sisi kiri konsol, pilih Call API > Authorized API SDK. Di halaman SDK, unduh SDK yang dihasilkan untuk aplikasi. API Gateway secara otomatis menghasilkan SDK untuk Objective-C, Android, dan Java. Untuk informasi tentang SDK dalam bahasa pemrograman lainnya, lihat bagian Contoh Panggilan dalam Bahasa Pemrograman Lain (Hanya untuk Referensi) di halaman SDK.

Metode 2 Di panel navigasi sisi kiri konsol, pilih OpenAPI > SDKs. Di halaman SDK, unduh SDK yang dihasilkan untuk grup API. API Gateway secara otomatis menghasilkan SDK untuk Objective-C, Android, Java, Golang, dan TypeScript.

2. Gunakan SDK untuk Memanggil API

Gambar berikut menunjukkan struktur direktori paket SDK yang telah diekstraksi yang Anda unduh dari konsol API Gateway.

• folder sdk

* sdk/{{regionId}} `Folder SDK untuk Java. Folder ini berisi kode untuk memanggil semua API di setiap grup.`

* HttpApiClient{{group}}.java `Menjelaskan cara memanggil API dalam grup tertentu melalui HTTP.`

* HttpsApiClient{{group}}.java `Menjelaskan cara memanggil API dalam grup tertentu melalui HTTPS.`

* WebSocketApiClient{{group}}.java `Menjelaskan cara memanggil API dalam grup tertentu melalui WebSocket.`

* Demo{{group}}.java `Berisi kode contoh dari semua panggilan API dalam grup tertentu.`

• folder doc/{{regionId}}

* ApiDocument_{{group}}.md `Menunjukkan dokumentasi API dalam grup tertentu.`

• folder lib

* sdk-core-java-1.1.5.jar `Paket inti SDK. Paket inti adalah dependensi SDK.`

* sdk-core-java-1.1.5-sources.jar `Kode sumber dari dependensi.`

* sdk-core-java-1.1.5-javadoc.jar `File JAR dari paket inti.`

Readme.md `Panduan pengguna SDK.`

LICENSE `Lisensi`

Untuk informasi tentang cara menggunakan SDK, lihat Readme.md.

Catatan: AppKey dan AppSecret digunakan untuk mengautentikasi permintaan pengguna di API Gateway. Jika AppKey dan AppSecret disimpan di sisi klien, pastikan untuk mengenkripsinya.

3. Pemecahan Masalah

Jika terjadi kesalahan saat menggunakan SDK untuk memanggil API, Anda dapat memperoleh ID permintaan dari header X-Ca-Request-Id dan memecahkan masalah tersebut. Untuk informasi lebih lanjut, lihat Pemecahan masalah yang terjadi selama debugging API.