API Gateway:Gunakan SDK untuk memanggil API

Sebelum memulai

SDK yang dihasilkan secara otomatis mencakup implementasi signature bawaan, sehingga Anda tidak perlu menangani perhitungan signature sendiri. Untuk mengimplementasikan otentikasi signature secara manual, lihat Petunjuk signature sisi client.

Selesaikan langkah-langkah dalam Buat API dengan layanan backend HTTP sebelum melanjutkan. API harus memenuhi semua persyaratan berikut agar dapat dipanggil oleh SDK:

• Metode otentikasi keamanan diatur ke Alibaba Cloud App.

• Aplikasi Anda telah diberi otorisasi untuk memanggil API tersebut.

• API telah dipublikasikan ke lingkungan online.

1. Unduh SDK

Konsol menyediakan dua opsi unduhan, tergantung pada apakah Anda menginginkan SDK berdasarkan aplikasi atau berdasarkan kelompok:

1. Berdasarkan aplikasi: Di panel navigasi kiri, pilih API Calls > SDKs, lalu klik tab Authorized APIs. Di bagian Auto-generated SDKs/Documents for Authorized APIs, unduh SDK untuk aplikasi Anda. Bahasa yang didukung untuk SDK yang dihasilkan otomatis: Objective-C, Android, dan Java. Contoh pemanggilan untuk bahasa lain tersedia di bagian bawah halaman.

2. Berdasarkan kelompok API: Di panel navigasi kiri, pilih API Calls > SDKs, lalu klik Group APIs. Di bagian Auto-generated SDKs/Documents, unduh SDK untuk kelompok API tersebut. Bahasa yang didukung untuk SDK yang dihasilkan otomatis: Objective-C, Android, Java, Go, dan TypeScript.

2. Gunakan SDK untuk memanggil API

Paket SDK yang telah diekstraksi berisi struktur direktori berikut:

• Folder sdk — file sumber SDK Java yang diorganisir berdasarkan Wilayah dan kelompok.

  * sdk/{{regionId}}: Folder SDK Java untuk semua Operasi API dalam setiap kelompok.

  * HttpApiClient{{group}}.java: Metode client untuk Operasi API yang menggunakan channel HTTP.

  * HttpsApiClient{{group}}.java: Metode client untuk Operasi API yang menggunakan channel HTTPS.

  * WebSocketApiClient{{group}}.java: Metode client untuk Operasi API yang menggunakan channel WebSocket.

  * Demo{{group}}.java: Contoh pemanggilan yang dapat dijalankan untuk semua Operasi API dalam kelompok tersebut.

• Folder doc/{{regionId}} — dokumentasi referensi API.

  * ApiDocument_{{group}}.md: Referensi API untuk kelompok yang sesuai.

• Folder lib — dependensi inti SDK.

  * sdk-core-java-1.1.5.jar: Paket inti SDK. Wajib digunakan.

  * sdk-core-java-1.1.5-sources.jar: Kode sumber untuk paket inti.

  * sdk-core-java-1.1.5-javadoc.jar: Dokumentasi Javadoc untuk paket inti.

• Readme.md: Panduan pengguna SDK dengan instruksi integrasi langkah demi langkah.

• LICENSE: Lisensi hak cipta.

Ikuti langkah-langkah dalam Readme.md untuk mengintegrasikan SDK ke dalam aplikasi Anda dan melakukan pemanggilan API.

3. Pemecahan Masalah

Jika pemanggilan gagal, ambil ID permintaan dari header respons untuk mengidentifikasi masalahnya. Untuk langkah-langkah diagnosis, lihat Debugging API dan Pemecahan Masalah Mandiri.