OAuth 사용

유럽 경제 지역 (EEA) 개발자

Solar API는 인증을 위해 OAuth 2.0 사용을 지원합니다. Google은 웹 서버용과 같은 일반적인 OAuth 2.0 시나리오를 지원합니다.

이 문서에서는 개발 환경에서 OAuth 토큰을 Solar API 호출에 전달하는 방법을 설명합니다. 프로덕션 환경에서 OAuth를 사용하는 방법은 Google에서 인증을 참고하세요.

시작하기 전에

Solar API를 사용하려면 결제 계정이 있고 Solar API가 사용 설정된 프로젝트가 필요합니다. 프로젝트 소유자 및 결제 관리자를 여러 명 만들어 이러한 역할을 맡은 담당자가 팀에 상주하도록 하는 것이 좋습니다. 자세한 내용은 Cloud Console에서 설정하기를 참고하세요.

OAuth 정보

배포 환경에 따라 OAuth로 액세스 토큰을 만들고 관리하는 방법은 다양합니다.

예를 들어 Google OAuth 2.0 시스템은 애플리케이션과 Google 서비스 간 상호작용과 같은 서버 간 상호작용을 지원합니다. 이 시나리오에서는 서비스 계정이 필요합니다. 서비스 계정은 개별 최종 사용자가 아닌 애플리케이션에 속한 계정입니다. 애플리케이션은 서비스 계정을 대신하여 Google API를 호출하므로 사용자가 직접 관여하지 않습니다. 인증 방법에 대한 자세한 내용은 Google 인증을 참고하세요.

또는 Android나 iOS 모바일 앱의 일부로 Solar API를 사용할 수도 있습니다. 다양한 배포 환경의 액세스 토큰 관리에 관한 정보를 비롯하여 Solar API와 함께 OAuth를 사용하는 방법에 관한 일반적인 내용은 OAuth 2.0을 사용하여 Google API에 액세스하기를 참고하세요.

OAuth 범위 정보

Solar API에서 OAuth를 사용하려면 OAuth 토큰에 다음 범위가 할당되어야 합니다.

  • https://www.googleapis.com/auth/cloud-platform

예: 로컬 개발 환경에서 REST API 호출 시도

OAuth 토큰을 사용하여 Solar API를 사용해 보려고 하지만 토큰을 생성할 환경이 설정되어 있지 않은 경우 이 섹션의 절차를 사용하여 호출할 수 있습니다.

이 예에서는 애플리케이션 기본 사용자 인증 정보 (ADC)에서 제공하는 OAuth 토큰을 사용하여 호출하는 방법을 설명합니다. ADC를 사용하고 클라이언트 라이브러리를 사용하여 Google API를 호출하는 방법은 클라이언트를 사용하여 인증을 참고하세요.

기본 요건

ADC를 사용하여 REST 요청을 수행하려면 먼저 Google Cloud CLI를 사용하여 ADC에 사용자 인증 정보를 제공해야 합니다.

  1. 아직 프로젝트를 만들고 결제를 사용 설정하지 않았다면 Google Cloud 콘솔에서 설정의 단계에 따라 프로젝트를 만들고 결제를 사용 설정합니다.
  2. gcloud CLI를 설치하고 초기화합니다.

  3. 로컬 머신에서 다음 gcloud 명령어를 실행하여 사용자 인증 정보 파일을 만듭니다.

    gcloud auth application-default login
  4. 로그인 화면이 표시됩니다. 로그인하면 사용자 인증 정보는 ADC에서 사용하는 로컬 사용자 인증 정보 파일에 저장됩니다.

자세한 내용은 애플리케이션 기본 사용자 인증 정보의 사용자 인증 정보 제공 문서의 로컬 개발 환경 섹션을 참고하세요.

REST 요청하기

이 예시에서는 두 개의 요청 헤더를 전달합니다.

  • 다음 명령어를 사용하여 토큰을 생성하여 Authorization 헤더에서 OAuth 토큰을 전달합니다.

    gcloud auth application-default print-access-token

    반환된 토큰의 범위가 https://www.googleapis.com/auth/cloud-platform.입니다.

  • 결제가 사용 설정된 Google Cloud 프로젝트의 ID 또는 이름을 X-Goog-User-Project 헤더에 전달합니다. 자세한 내용은 Cloud 콘솔에서 설정하기를 참고하세요.

다음 예에서는 OAuth 토큰을 사용하여 Solar API를 호출합니다.

curl -X GET \
-H 'X-Goog-User-Project: PROJECT_NUMBER_OR_ID' \
-H "Authorization: Bearer $TOKEN" \
"https://solar.googleapis.com/v1/dataLayers:get?location.latitude=37.4450&location.longitude=-122.1390&radius_meters=100&required_quality=HIGH"

문제 해결

요청이 API에서 지원되지 않는 최종 사용자 인증 정보에 대해 오류 메시지를 반환하는 경우 사용자 인증 정보가 작동하지 않음을 참고하세요.