All Products
Search

This Product

    API Gateway:Kelola konsumen

    Document Center

    API Gateway:Kelola konsumen

    Last Updated:Jun 03, 2026

    API Gateway berbasis cloud menggunakan konsumen untuk mengaktifkan autentikasi pada entri rute dan API. Anda dapat membuat, menonaktifkan, dan menghapus konsumen melalui Konsol.

    Buat konsumen

    API Gateway berbasis cloud menyediakan tiga metode autentikasi.

    Metode

    Deskripsi

    Kapan digunakan

    API key

    Klien menambahkan kredensial ke permintaan. Gerbang memvalidasi legitimasi dan izinnya. Kurang aman dibandingkan JWT atau AK/SK. Lindungi kredensial Anda dengan hati-hati.

    Skema integrasi ringan dan cepat dengan persyaratan keamanan rendah.

    JWT

    JWT adalah standar untuk mentransmisikan informasi secara aman antara klien dan server menggunakan signature HMAC, RSA, atau ECDSA. Gunakan JWT untuk verifikasi identitas dan kontrol akses di gerbang.

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

    HMAC

    Klien menggunakan pasangan AK/SK untuk menandatangani konten permintaan dengan algoritma HMAC, lalu mengirimkan signature tersebut ke gerbang untuk divalidasi.

    Skema yang memerlukan integritas data tinggi dan proteksi anti-pemalsuan.

    Buat konsumen dengan autentikasi API key

    1. Buka halaman Consumers di Konsol API Gateway berbasis cloud dan pilih Wilayah.

    2. Klik Create a consumer. Di panel Create Consumer, atur Consumer Name, pilih API Key sebagai metode autentikasi, lalu lengkapi konfigurasi berikut:

      • Generation Method:

        • System Generated: Sistem secara otomatis menghasilkan kunci API untuk Anda.

        • Custom: Tentukan kunci API kustom dan sumbernya.

      • Credential: Kunci API kustom.

      • Credential Source:

        Lokasi dalam permintaan tempat gerbang mengambil kunci API:

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

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

        • Custom Query Parameter (misalnya ?apikey=your-key)

    Buat konsumen dengan autentikasi JWT

    1. Buka halaman Consumers di Konsol API Gateway berbasis cloud dan pilih Wilayah.

    2. Klik Create a consumer. Di panel Create Consumer, atur Consumer Name, pilih JSON Web Token (JWT) sebagai metode autentikasi, lalu lengkapi konfigurasi berikut:

      • Creation Method:

        • Local Configuration: Gunakan ketika layanan autentikasi dan gerbang berada dalam kluster atau LAN yang sama, memerlukan performa tinggi, dan kunci jarang berubah.

        • Remote Fetch: Gunakan dengan pusat identitas terpadu seperti OAuth2 atau OpenID Connect. Mendukung pembaruan kunci dinamis. Ideal untuk lingkungan multi-penyewa atau produksi.

      • Key Type (tidak diperlukan untuk Remote Fetch):

        • Symmetric Key: Menghasilkan konfigurasi JWKS default yang unik untuk setiap konsumen, berisi kunci untuk enkripsi dan dekripsi token.

        • Asymmetric Key: Berikan konfigurasi JWKS lengkap dan gunakan kunci privat untuk mengenkripsi token. Gerbang mendekripsi dengan kunci publik dalam JWKS.

      • JWKS:

        • Jika Anda memilih Local Configuration, konfigurasikan JWKS sesuai spesifikasi JSON Web Key (JWK).

        • Jika Anda memilih Remote Fetch, masukkan URL. Sistem secara otomatis mengurai nomor Port, periode timeout, dan durasi cache dari URL tersebut.

          Penting

          URL harus berupa Nama domain, bukan alamat IP.

      • JWT Token: Atur konfigurasi token JWT.

        • Type: Jenis parameter token. Nilai default adalah Header.

        • Key: Nama parameter token.

        • Prefix: Awalan parameter token. Nilai default menggunakan Header Authorization dengan awalan Bearer, contohnya Authorization: Bearer token.

        • Enable Passthrough: Meneruskan parameter token ke layanan backend.

      • Consumer ID in JWT Payload: Pasangan kunci-nilai dalam muatan JWT yang mengidentifikasi konsumen. Nilai default adalah `uid` dengan nilai string acak. Dapat dikustomisasi. Contoh muatan:

        {
  "uid": "11215ac069234abcb8944232b79ae711"
}

    Buat konsumen dengan autentikasi HMAC

    1. Buka halaman Consumers di Konsol API Gateway berbasis cloud dan pilih Wilayah.

    2. Klik Create a consumer. Di panel Create Consumer, atur Consumer Name, pilih Hash-based Message Authentication Code (HMAC) sebagai metode autentikasi, lalu lengkapi konfigurasi berikut:

      • System Generated: Sistem secara otomatis menghasilkan Access Key (AK) dan Secret Key (SK) untuk Anda.

      • Custom: Tentukan AK dan SK kustom.

    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 Consumers, temukan konsumen yang dituju, klik Disable di kolom Actions, lalu klik OK untuk mengonfirmasi.

    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 Consumers, temukan konsumen yang dituju, lalu klik Delete di kolom Actions. Di kotak dialog konfirmasi, masukkan nama konsumen, lalu klik Delete.