API 키 사용

이 페이지에서는 API 게이트웨이에서 API 키를 사용하는 방법을 설명합니다.

API 키는 할당량, 청구, 모니터링 목적으로 Google Cloud 프로젝트를 식별하는 간단한 문자열입니다. 개발자는 Google Cloud 콘솔에서 프로젝트에 API 키를 생성하고 API에 대한 모든 호출에 이 키를 쿼리 매개변수로 또는 요청 헤더에 포함합니다.

API 구성에 API 키 요구사항을 지정하면 API 게이트웨이가 이 API 키를 사용해서 연결된 Google Cloud 프로젝트를 조회합니다. API 키가 Google Cloud 프로젝트에서 또는 API가 사용 설정된 다른 Google Cloud 프로젝트 내에서 생성되지 않았으면 API 게이트웨이가 요청을 거부합니다.

API 키를 만들거나 Google Cloud 프로젝트 내에서 이미 제공된 API 키를 보려면 API 및 서비스 > 사용자 인증 정보 페이지로 이동합니다.

사용자 인증 정보로 이동

사용 사례

할당량과 같은 API 게이트웨이 기능을 사용하려면 클라이언트 애플리케이션이 연결된 Google Cloud 프로젝트를 API 게이트웨이가 식별할 수 있도록 API 키를 전달할 수 있습니다.

API 게이트웨이의 API 키 인증 정보

인증을 위해 API 키를 사용하는 경우 먼저 서비스에 대해 API 키 지원을 사용 설정해야 합니다.

다음 명령어를 입력합니다. 

gcloud services enable MANAGED_SERVICE_NAME

MANAGED_SERVICE_NAME은 API를 배포할 때 만든 관리형 서비스의 이름을 지정합니다. 이 이름은 콘솔의 API 방문 페이지에서 API에 대한 관리형 서비스 열에서 찾을 수 있습니다. 또는 gcloud api-gateway apis describe 명령어를 사용할 때 Managed service 속성에서 이 이름을 찾을 수 있습니다.

예를 들면 다음과 같습니다.

gcloud services enable my-api-a12bcd345e67f89g0h.apigateway.my-project.cloud.goog

API 키 제한

API 키는 기본적으로 무제한 상태입니다. 무제한 키는 어디서나 사용할 수 있으므로 안전하지 않습니다. 가능하면 API 제한사항을 추가하는 것이 좋습니다. API 제한사항은 API 키를 사용해서 호출할 수 있는 API를 지정합니다. 프로덕션 애플리케이션에서 사용하는 모든 API 키에는 API 제한사항이 있어야 합니다.

API 제한사항을 추가하려면 다음 안내를 따르세요.

  1. API 구성에 명시된 API 제목을 찾습니다. 다음 예시에서 API 제목은 My Example Config입니다.

    # openapi.yaml
swagger: '2.0'
info:
  title: My Example Config
  description: Sample API on API Gateway
  version: 1.0.0
...

  2. Google Cloud 콘솔에서 API 및 서비스 > 사용자 인증 정보 페이지로 이동합니다.

    사용자 인증 정보로 이동

  3. API에 사용할 API 키의 이름을 선택합니다.

  4. API 키 세부정보 페이지의 API 제한사항 섹션에서 키 제한을 클릭합니다.

  5. 사용 가능한 API의 드롭다운 목록에서 API 키를 사용하여 액세스할 API를 선택합니다. 예를 들어 위 구성 예시를 사용하는 경우 My Example Config를 선택합니다.

  6. 저장을 클릭합니다.

일시적으로 제한사항이 적용됩니다.