Menggunakan Kunci API

Halaman ini menjelaskan cara menggunakan kunci API di API Gateway.

Ringkasan

Kunci API adalah string yang mengidentifikasi project untuk tujuan kuota, penagihan, dan pemantauan.Google Cloud Developer membuat kunci API di project di konsol Google Cloud . Kemudian, mereka menyematkan kunci tersebut di setiap panggilan ke API Anda sebagai parameter kueri atau di header permintaan.

Jika Anda menentukan persyaratan kunci API dalam konfigurasi API, API Gateway akan menggunakan kunci API untuk mencari project terkait. Google Cloud API Gateway menolak permintaan kecuali jika kunci API dibuat di project Google Cloud Anda atau dalam projectGoogle Cloud lain tempat API Anda telah diaktifkan.

Membuat kunci API

Untuk membuat kunci API, atau melihat kunci API yang sudah tersedia dalam project Google Cloud Anda, buka halaman APIs & Services > Credentials, lalu selesaikan langkah-langkah yang dijelaskan dalam Membuat kunci API.

Buka Kredensial

Mengonfigurasi autentikasi kunci API untuk API Gateway

Konfigurasi autentikasi kunci API untuk API Gateway guna mengamankan akses ke gateway Anda menggunakan kunci API, seperti yang dijelaskan di bagian berikut.

  1. Aktifkan dukungan kunci API untuk layanan Anda.

    KonsolGoogle Cloud

    Lakukan tindakan berikut:

    1. Di konsol Google Cloud , buka APIs & Services > Library.

      Buka Library API & Layanan

    2. Di kotak penelusuran, masukkan nama Managed Service API. Anda dapat menemukan nilai ini di kolom Managed Service untuk API Anda di halaman landing API. Contoh: 
      my-api-123abc456def1.apigateway.my-project.cloud.goog
    3. Klik kartu layanan untuk melihat halaman landing.
    4. Di halaman landing untuk layanan Anda, klik Aktifkan.

    Google Cloud CLI

    Masukkan perintah berikut, dengan MANAGED_SERVICE_NAME menentukan nama layanan terkelola yang dibuat saat Anda men-deploy API. Hal ini dapat dilihat di properti Managed Service yang tercantum dengan perintah gcloud api-gateway apis describe.

    gcloud services enable MANAGED_SERVICE_NAME

    Contoh:

    gcloud services enable my-api-123abc456def1.apigateway.my-project.cloud.goog
  2. Ubah spesifikasi OpenAPI yang digunakan untuk membuat konfigurasi API Anda agar menyertakan petunjuk untuk menerapkan kebijakan keamanan validasi kunci API pada semua traffic. Tambahkan jenis security dan securityDefinitions atau securitySchemes seperti yang ditunjukkan:

    OpenAPI 2.0

      # openapi2-functions.yaml
  swagger: '2.0'
  info:
    title: API_ID optional-string
    description: Sample API on API Gateway with a Google Cloud Functions backend
    version: 1.0.0
  schemes:
    - https
  produces:
    - application/json
  paths:
    /hello:
      get:
        summary: Greet a user
        operationId: hello
        x-google-backend:
          address: https://GCP_REGION-PROJECT_ID.cloudfunctions.net/helloGET
        security:
        - api_key: []
        responses:
          '200':
            description: A successful response
            schema