API 키로 API 액세스 제한

API 키를 사용하여 특정 API 메서드 또는 API의 모든 메서드에 대한 액세스를 제한할 수 있습니다. 이 페이지에서는 API 키가 있는 클라이언트로 API 액세스를 제한하는 방법과 API 키를 만드는 방법을 설명합니다.

API에 API 키 요구사항을 설정하면 보호되는 메서드, 클래스 또는 API에 대한 요청은 내 프로젝트나 내가 API 사용 설정 권한을 부여한 개발자가 소유한 다른 프로젝트에서 생성된 키가 포함된 경우를 제외하고는 모두 거부됩니다. API 키가 생성된 프로젝트는 로깅되지 않으며 요청 헤더에 추가되지 않습니다. 그러나 특정 소비자 프로젝트를 위한 필터의 설명대로 Endpoints 서비스 페이지에서 클라이언트와 연결된 Google Cloud project를 볼 수 있습니다.

API 키를 만들어야 하는 Google Cloud 프로젝트에 대한 자세한 내용은 API 키로 보호되는 API 공유를 참조하세요.

모든 API 메서드에 대한 액세스 제한

API에 대한 모든 호출에 API 키가 필요하도록 만들려면 apiKeyRequired = AnnotationBoolean.TRUE을 @Api 주석에 추가합니다. 예를 들면 다음과 같습니다.

@Api(
  name = "echo",
  version = "v1",
  apiKeyRequired = AnnotationBoolean.TRUE
  )
public class Echo {
//API class and methods...
}

특정 API 메서드에 대한 액세스 제한

특정 API 메서드에 대한 모든 호출에 API 키가 필요하도록 만들려면 apiKeyRequired = AnnotationBoolean.TRUE를 @ApiMethod 주석에 추가합니다. 예를 들면 다음과 같습니다.

@ApiMethod(name = "echo_api_key", path = "echo_api_key", apiKeyRequired = AnnotationBoolean.TRUE)
public Message echoApiKey(Message