全部产品
Search
文档中心

API Gateway:Memanggil API dalam mode otentikasi sederhana

更新时间:Jul 02, 2025

Alibaba Cloud API Gateway menyediakan beberapa metode untuk mengotentikasi permintaan dari klien, termasuk Alibaba Cloud App, Plugin JSON Web Token (JWT), dan plugin otentikasi pihak ketiga. Metode Alibaba Cloud App mencakup dua mode otentikasi: tanda tangan dan AppCode. Topik ini menjelaskan cara menggunakan metode otentikasi sederhana berdasarkan AppCode dari suatu aplikasi.

Perhatian

Otentikasi sederhana menghilangkan kebutuhan akan proses penandatanganan yang kompleks. Namun, AppCodes terpapar sebagai teks biasa selama transmisi, yang menimbulkan risiko keamanan tertentu. Kami menyarankan Anda berhati-hati saat menggunakan mode ini.

Penting

Make sure that HTTPS communication is used between the client and API Gateway. Do not transmit data over HTTP. In simple authentication mode, AppCodes are transmitted in plaintext. If you use the unencrypted HTTP protocol, plaintext AppCodes can be easily obtained by attackers who capture packets.

Ikhtisar

  • Untuk informasi lebih lanjut tentang cara permintaan ditandatangani, lihat Gunakan otentikasi digest untuk memanggil API.

  • Dalam otentikasi sederhana berbasis AppCode, pemanggil API diautentikasi menggunakan AppCodes yang diterbitkan oleh API Gateway. Pemanggil melewati AppCodes sebagai header permintaan atau parameter Query untuk mengautentikasi identitas mereka. Dengan cara ini, mereka dapat memanggil APIs secara efisien. Berikut adalah langkah-langkah untuk menggunakan otentikasi sederhana berbasis AppCode:

    1. Buat API yang mendukung otentikasi AppCode.

    2. Buat aplikasi dan dapatkan AppCode yang diterbitkan untuk aplikasi tersebut.

    3. Otorisasi aplikasi untuk memanggil API.

    4. Gunakan AppCode untuk memanggil API, di mana AppCode digunakan untuk autentikasi identitas selama proses ini.

Buat API yang mendukung otentikasi AppCode

  1. Masuk ke Konsol API Gateway. Di panel navigasi sebelah kiri, pilih Manage APIs > API Groups. Di halaman Grup API, klik Create Group di pojok kanan atas.

  2. Di halaman Buat Grup, atur Instances ke instans API Gateway yang telah dibuat, konfigurasikan parameter Group Name dan BasePath, lalu klik Confirm.

  3. Di panel navigasi sebelah kiri, pilih Manage APIs > APIs. Di halaman APIs, klik Create API di pojok kanan atas.

  4. Di langkah Informasi Dasar wizard Buat API, pilih grup API yang dibuat dari daftar drop-down Group, konfigurasikan parameter API Name, atur Authentication Method ke Alibaba Cloud App, dan atur AppCode Authentication ke Enable AppCode Authentication (Header) atau Enable AppCode Authentication (Header & Query).

    358fcadb17655c8e8d14e358d2d96d67

    Tabel berikut menjelaskan empat opsi untuk Otentikasi AppCode:

    Opsi

    Deskripsi

    Aktifkan Setelah API Dipublikasikan ke Alibaba Cloud Marketplace

    Secara default, opsi ini tidak dipilih. Jika Anda memilih opsi ini, AppCodes dapat dilewatkan sebagai header permintaan untuk otentikasi setelah API dipublikasikan ke Alibaba Cloud Marketplace.

    Nonaktifkan Otentikasi AppCode

    Permintaan harus ditandatangani terlepas dari apakah API dipublikasikan ke Alibaba Cloud Marketplace.

    Aktifkan Otentikasi AppCode (Header)

    AppCodes dapat dilewatkan sebagai header permintaan untuk otentikasi terlepas dari apakah API dipublikasikan ke Alibaba Cloud Marketplace.

    Aktifkan Otentikasi AppCode (Header & Query)

    AppCodes dapat dilewatkan sebagai header permintaan atau parameter Query untuk otentikasi terlepas dari apakah API dipublikasikan ke Alibaba Cloud Marketplace.

  5. Pilih algoritma tanda tangan dan klik Next.

  6. Di langkah Define API Request, tentukan persyaratan pada permintaan yang dikirim untuk memanggil API Anda. Untuk informasi lebih lanjut, lihat Konfigurasikan informasi permintaan. Lalu, klik Next.

  7. Di langkah Define Backend Service, konfigurasikan layanan backend untuk API Anda. Untuk informasi lebih lanjut, lihat Konfigurasikan layanan backend. Lalu, klik Save.

Catatan
  • Catatan: Saat menentukan parameter permintaan untuk API, Anda tidak perlu mendefinisikan bahwa permintaan harus membawa header AppCode atau parameter Header.

  • Setelah API dibuat, Anda dapat mempublikasikannya ke lingkungan untuk debugging lebih lanjut.

Buat aplikasi

  1. Masuk ke Konsol API Gateway. Di panel navigasi sebelah kiri, pilih Call APIs > Apps. Di halaman Aplikasi, klik Create App di pojok kanan atas.

  2. Di kotak dialog Buat Aplikasi, atur App Name dan klik Confirm.

Catatan
  • Sebuah AppCode secara otomatis dibuat untuk aplikasi yang dibuat. Anda dapat menemukan AppCode di halaman App Details dengan mengklik nama aplikasi di halaman Apps.

  • Jika Anda membeli API dari Alibaba Cloud Marketplace, marketplace akan membuat aplikasi untuk Anda saat Anda melakukan pembelian.

Otorisasi aplikasi untuk memanggil API

  1. Masuk ke Konsol API Gateway. Di panel navigasi di sebelah kiri, pilih Manage APIs > APIs. Di halaman APIs, temukan API yang dibuat dan klik image > Authorize di kolom Actions.

  2. Di kotak dialog Otorisasi, konfigurasikan parameter Stage, Authorization Validity Period, dan Choose Apps for Authorization. Pilih My Apps dari daftar drop-down Pilih Aplikasi untuk Otorisasi dan klik Search. Aplikasi di akun Anda akan otomatis ditampilkan. Pilih aplikasi yang dibuat dan klik Add Selected untuk menambahkan aplikasi. Lalu, klik Confirm.

Gunakan AppCode untuk autentikasi identitas

Otentikasi sederhana mendukung dua mode. Anda dapat meletakkan AppCode di bagian Header atau bagian Query dari permintaan Anda.

Metode 1: Tambahkan AppCode ke bagian Header

  • Tambahkan parameter Authorization ke Header permintaan.

  • Nilai parameter Authorization harus dalam format berikut: APPCODE + Spasi + nilai AppCode. Format:

    Authorization:APPCODE Nilai AppCode

    Contoh:

    Authorization:APPCODE 3F2504E04F8911D39A0C0305E82C3301
    Penting

    Jika layanan backend adalah fungsi HTTP, parameter Authorization tidak diteruskan ke layanan backend. Sebagai gantinya, parameter tersebut ditimpa oleh parameter Authorization dari fungsi HTTP. Kami menyarankan Anda meletakkan AppCodes di bagian Query.

Metode 2: Tambahkan AppCode ke bagian Query

  • Tambahkan parameter AppCode ke bagian Query dari permintaan Anda. AppCode juga dapat ditulis sebagai appcode, appCode, APPCODE, dan APPCode.

  • Nilai parameter adalah AppCode yang diterbitkan.

Contoh:

http://www.aliyum.com?AppCode=3F2504E04F8911D39A0C0305E82C3301