全部产品
Search
文档中心

API Gateway:Kelola konsumen

更新时间:Nov 10, 2025

API Gateway berbasis cloud memungkinkan autentikasi entri rute dan API menggunakan konsumen. Topik ini menjelaskan cara mengelola konsumen di Konsol API Gateway berbasis cloud.

Buat konsumen

API Gateway berbasis cloud menyediakan tiga metode autentikasi.

Metode konfigurasi

Deskripsi

Skenario Penerapan

API Key

Klien harus menambahkan kredensial ke permintaan dengan cara tertentu, dan gerbang memverifikasi legitimasi serta izin tersebut. Metode ini cocok untuk skenario operasi non-sensitif. Metode ini memberikan tingkat keamanan yang lebih rendah dibandingkan autentikasi JWT dan AK/SK. Anda perlu memperhatikan manajemen dan perlindungan kredensial.

Cocok untuk skenario integrasi ringan dan cepat serta skenario dengan persyaratan keamanan yang lebih rendah.

JWT

JSON Web Token (JWT) adalah standar untuk mentransmisikan informasi secara aman antara klien dan server. JWT menggunakan tanda tangan HMAC, RSA, atau ECDSA untuk memastikan bahwa informasi tersebut dapat diverifikasi dan dapat dipercaya. Autentikasi JWT dapat menerapkan autentikasi dan kontrol akses di gerbang.

Cocok untuk sistem terdistribusi dan skenario Single Sign-On (SSO).

HMAC

Metode autentikasi tanda tangan AK/SK berbasis algoritma HMAC mengharuskan klien menghitung tanda tangan untuk konten permintaan dengan menggunakan kunci tanda tangan saat memanggil API, lalu mengirimkan tanda tangan tersebut ke server untuk verifikasi.

Cocok untuk skenario dengan persyaratan tinggi terhadap integritas data dan proteksi anti-pemalsuan.

Buat konsumen berdasarkan autentikasi API key

  1. Buka halaman Konsumen di Konsol API Gateway berbasis cloud dan pilih Wilayah tempat Anda ingin membuat konsumen.

  2. Klik Create Consumer. Pada panel Create Consumer, konfigurasikan Consumer Name, pilih API Key sebagai metode autentikasi, lalu lengkapi konfigurasi berikut:

    • Metode Generasi:

      • System Generated: Sistem secara otomatis menghasilkan kredensial API key.

      • Custom: Anda perlu menentukan kredensial API key dan sumber kredensial.

    • Kredensial (tidak diperlukan jika System Generated dipilih): Sesuaikan kredensial API key.

    • Sumber Kredensial:

      Menentukan dari mana gerbang mengekstraksi API key dalam permintaan. Sumbernya meliputi:

      • Authorization: Bearer <token> (format token standar)

      • Custom HTTP Header (seperti X-API-Key: your-key)

      • Custom Query Parameters (seperti ?apikey=your-key)

Buat konsumen berdasarkan autentikasi JWT

  1. Buka halaman Konsumen di Konsol API Gateway berbasis cloud dan pilih Wilayah tempat Anda ingin membuat konsumen.

  2. Klik Create Consumer. Pada panel Create Consumer, konfigurasikan Consumer Name, pilih JWT sebagai metode autentikasi, lalu lengkapi konfigurasi berikut:

    • Metode Pembuatan:

      • Local Configuration cocok untuk skenario di mana layanan autentikasi dan gerbang berada dalam kluster atau jaringan area lokal yang sama, dengan persyaratan performa tinggi dan perubahan kunci yang jarang terjadi.

      • Remote Fetch cocok untuk skenario yang menggunakan pusat identitas terpadu (seperti OAuth2, OpenID Connect) untuk menerbitkan JWT, mendukung pembaruan kunci dinamis, dan sesuai untuk lingkungan multi-penyewa atau lingkungan produksi.

    • Jenis Kunci (tidak diperlukan jika Remote Fetch dipilih):

      • Symmetric Key: JWKS default dihasilkan. JWKS bervariasi berdasarkan konsumen. JWKS default berisi kunci yang digunakan untuk mengenkripsi atau mendekripsi token.

      • Asymmetric Key: Anda harus memasukkan konfigurasi JWKS lengkap. Token dienkripsi menggunakan kunci privat. Gerbang melakukan dekripsi berdasarkan kunci publik dalam JWKS.

    • JWKS:

      • Saat Local Configuration dipilih, atur konfigurasi JWKS. Untuk informasi lebih lanjut tentang spesifikasi JWKS, lihat JSON Web Key (JWK).

      • Saat Remote Fetch dipilih, atur URL. Sistem secara otomatis mengurai dan membaca informasi, termasuk nomor port, waktu tunggu, dan waktu cache.

        Penting

        URL harus berupa nama domain, bukan alamat IP.

    • Token JWT: Konfigurasikan informasi token JWT.

      • Type: jenis token. Nilai default: HEADER.

      • Key: nama token.

      • Prefix: awalan token. Konfigurasikan parameter yang diperlukan untuk memvalidasi token. Secara default, token berisi awalan Bearer dan disimpan di Authorization Header. Contoh: Authorization: Bearer token.

      • Enable Passthrough: Jika Anda memilih opsi ini, token akan diteruskan secara transparan ke layanan backend.

    • Identitas Konsumen dalam Muatan JWT: Kunci dan nilai dalam muatan JWT yang digunakan untuk mengidentifikasi konsumen. Secara default, kuncinya adalah uid, dan nilainya adalah string acak. Anda dapat mengubah nilai tersebut sesuai kebutuhan bisnis Anda. Kode berikut merupakan contoh muatan dalam token JWT:

      {
        "uid": "11215ac069234abcb8944232b79ae711"
      }

Buat konsumen berdasarkan autentikasi HMAC

  1. Buka halaman Konsumen di Konsol API Gateway berbasis cloud dan pilih Wilayah tempat Anda ingin membuat konsumen.

  2. Klik Create Consumer. Di panel Create Consumer, konfigurasikan Consumer Name, pilih HMAC sebagai metode autentikasi, dan lengkapi konfigurasi berikut:

    • System Generated: Sistem secara otomatis menghasilkan Pasangan Kunci Akses.

    • Custom: Anda perlu menentukan Pasangan Kunci Akses.

Nonaktifkan konsumen

  1. Masuk ke Konsol API Gateway.

  2. Di panel navigasi sebelah kiri, klik Consumers. Di bilah navigasi atas, pilih Wilayah.

  3. Di halaman daftar Consumer, klik Disable di kolom Actions konsumen yang dituju. Di kotak dialog konfirmasi, klik OK.

Hapus konsumen

  1. Masuk ke Konsol API Gateway.

  2. Di panel navigasi sebelah kiri, klik Consumers. Di bilah navigasi atas, pilih Wilayah.

  3. Di halaman daftar Consumer, klik Delete di kolom Actions konsumen yang dituju. Di kotak dialog konfirmasi, masukkan nama konsumen saat ini, lalu klik Delete.