OAuth 2.0을 사용하여 애플리케이션 승인 (호텔 API에 액세스할 때)
OAuth 2.0 설정
OAuth 2.0을 사용하려면 서비스 계정을 사용하여 본인 확인을 해야 합니다. Google 계정과 연결되어 있어야 합니다. 서비스 계정은 키를 사용하는 대신 OAuth 2.0 액세스 토큰을 사용할 수 있습니다. 그런 다음 이 토큰을 사용하여 읽기 전용 데이터에 대한 호텔 API 호출(가격, 호텔, 호텔 가격 피드에 대한 진단 보고 데이터를 제공합니다.
액세스 토큰은 1시간 (3,600초) 동안 유효합니다.
이전에 ClientLogin을 구현했다면 OAuth 2.0 접근 방식이 유사합니다. 다음과 같은 차이점이 있습니다.
- 애플리케이션은 Google 서비스 계정을 사용하여 API에 액세스합니다.
- 다음과 같은 경우
Authorization
HTTP 헤더에 OAuth 2.0 액세스 토큰을 전달합니다. API 호출
Travel Partner API로 OAuth 2.0을 사용하도록 계정을 설정하려면 다음 단계를 따르세요.
다음 섹션에서 각 단계를 설명합니다.
1단계: 새 DevConsole 프로젝트 만들기
Google Developers Console('DevConsole')은 Google의 개발자 환경입니다. - 트래픽 데이터, 인증 및 결제 정보의 관리 및 조회 프로젝트에서 사용하는 Google API에 액세스할 수 있습니다
DevConsole에서 프로젝트는 설정, 사용자 인증 정보, 작업 중인 애플리케이션 한 개 또는 여러 개에 대한 메타데이터 Google Developer API와 Google Cloud 리소스를 사용합니다.
DevConsole에서는 프로젝트의 이러한 측면을 관리할 수 있습니다. 예를 들면 다음과 같습니다. API 사용자 인증 정보 생성, API 활성화, 팀 및 결제 관리 프로젝트 관련 정보를 볼 수 있습니다
새 DevConsole 프로젝트를 만들려면 다음 단계를 따르세요.
Gmail/Google 계정에 로그인합니다.
Google Developer Console을 엽니다. 첫 번째 프로젝트인 경우 기본 뷰에 다음과 같은 간단한 프로젝트 만들기 버튼:
프로젝트 만들기 버튼을 클릭합니다. DevConsole은 New Project 대화상자:
프로젝트 이름에 새 프로젝트의 친숙한 이름을 입력합니다. 입력합니다. 필드 아래에서 DevConsole이 프로젝트 ID를 생성합니다. ID가 모든 프로젝트에서 고유해야 합니다. 예를 들어 'My New Project'를 입력하면 DevConsole은
my-new-project-266022
만들기 버튼을 클릭하여 새 프로젝트를 만듭니다.
탐색 메뉴에서 API 및 서비스 > 대시보드를 클릭합니다.
아래 이미지는 왼쪽 상단에 있는 탐색 메뉴를 보여 줍니다. 살펴보겠습니다 이렇게 하면 프로젝트의 대시보드 뷰가 표시됩니다.
자세한 내용은 Google 개발자 콘솔에서 프로젝트 관리 콘솔을 엽니다.
새 프로젝트를 만들 때 프로젝트에 연결된 API가 아직 없습니다. 다음 단계에서는 새 프로젝트에 Travel Partner API를 사용 설정합니다.
2단계: 새 프로젝트에 Travel Partner API 사용 설정
호텔 API를 사용하려면 새 DevConsole 프로젝트에서 Travel Partner API를 사용 설정해야 합니다.
새 프로젝트에 호텔 API를 사용 설정하려면 다음 안내를 따르세요.
위에서 설명한 대로 프로젝트의 대시보드 뷰로 이동합니다.
API 및 서비스 사용 설정을 클릭합니다. 그러면 API 라이브러리 환영 메시지가 표시됩니다. 있습니다.
검색창에 Travel Partner API를 입력합니다. Google API 콘솔에는 입력한 내용과 일치하는 API 목록이 표시됩니다.
일치하는 API 표에서 Travel Partner API를 클릭합니다. DevConsole API에 대한 설명이 표시됩니다
API 사용 설정 버튼을 클릭하여 프로젝트에서 이 API를 사용 설정합니다.
자세한 내용은 활성화 및 비활성화를 참조하세요. API를 참고하세요.
이제 Google 계정의 새 프로젝트에 Hotel API가 사용 설정되었습니다.
다음 단계는 서비스 계정을 만들고 키를 생성하는 것입니다.
3단계: 서비스 계정 만들기 및 사용자 인증 정보 생성
서비스 계정은 서버 간 상호작용에 사용됩니다. 호텔 데이터를 관리할 수 있습니다.
서비스 계정을 만들고 구성하려면 다음 안내를 따르세요.
Google API 콘솔 기본 보기에서 Credentials를 클릭합니다. 왼쪽 탐색 메뉴로 이동합니다. DevConsole에 Credentials(사용자 인증 정보) 뷰가 표시됩니다.
사용자 인증 정보 보기에는 살펴보겠습니다 애플리케이션은 OAuth 2.0 액세스 토큰입니다. 새 프로젝트에 클라이언트 또는 사용자 인증 정보가 없음 있습니다.
API 및 서비스의 사용자 인증 정보 링크를 클릭합니다.
사용자 인증 정보 만들기 버튼을 클릭하고 서비스 계정 키를 선택합니다. 선택합니다. 서비스 계정 키 만들기 뷰가 표시됩니다.
서비스 계정 드롭다운에서 새 서비스 계정을 선택합니다.
서비스 계정 이름과 서비스 계정 ID를 입력합니다.
원하는 이름을 지정할 수 있지만 계정 ID는 고유해야 합니다. 전체 프로젝트입니다 DevConsole은 사용자를 위한 고유한 계정 ID를 생성하며, 표시됩니다.
아래와 같이 키 유형으로 P12를 선택합니다. P12는 필수 항목입니다.
만들기 버튼을 클릭합니다. 비공개/공개 키 쌍을 생성하는 DevConsole 사용할 수 있습니다 비공개 키는 비공개 키가 있는 기본 위치에 브라우저에서 다운로드 항목을 저장합니다. 그러려면 먼저
.json
파일 형식이 아닌.p12
형식 (바이너리)입니다.스크립트 또는 API에 액세스하는 다른 애플리케이션에서 Travel Partner API
DevConsole은 인스턴스 생성이 완료되면 다음 알림을 표시합니다. 키:
확인 버튼을 클릭합니다. DevConsole을 통해 사용자 인증 정보 뷰 서비스 계정에 대한 세부정보 및 프로젝트와 연결된 서비스 계정을 보려면 관리 서비스 계정이 표시됩니다.
이제 서비스 계정에 다음과 같은 사용자 인증 정보가 연결되어 있습니다.
- 클라이언트 ID: 애플리케이션에서 사용하는 고유 식별자입니다. OAuth 2.0 액세스 토큰을 요청합니다.
- 이메일 주소: 서비스 계정을 위해 양식 'account_name@account_name.google.com.iam.gserviceaccount.com').
- 인증서 지문:인증서로 전송하는 비공개 키의 ID 다운로드되었습니다.
자세한 내용은 서버에서 OAuth 2.0을 사용하여 서버 애플리케이션을 참조하세요.
4단계: 서비스 계정에 Hotel Center 데이터에 대한 액세스 권한 부여하기
마지막 단계는 새 서비스 계정에 Hotel Center 서비스 계정은 사용할 수 있습니다 다음을 사용하여 이 계정에 대한 액세스 권한을 제공합니다. Hotel Center 공유 설정
서비스 계정에 Hotel Center 데이터에 대한 액세스 권한을 부여하려면 다음 안내를 따르세요.
계정에 사용자를 추가할 수 있는 적절한 액세스 권한이 없는 경우 문의하기 양식을 사용하여 Google 호텔팀에 계정을 만들 수 있습니다. 소유자에게 이메일을 하나 이상 전송하도록 요청할 수 있습니다. Hotel Center 액세스 권한에 대한 자세한 내용은 Hotel Center 연결 및 Google Ads
새 브라우저 창에서 Hotel Center를 엽니다.
Hotel Center by Google 배너에서 사용자 추가 아이콘을 클릭하여 엽니다. 공유할 수 있습니다.
사용자 추가 필드에 서비스의 이메일 주소를 입력합니다. Hotel Center에 추가할 계정
이메일 알림 보내기 옵션을 선택된 상태로 둡니다.
드롭다운 메뉴에서 관리를 선택합니다.
초대 버튼을 클릭합니다.
Hotel Center에 사용자를 추가한 후 서비스 계정은 API 액세스가 약 24시간 이내에 사용 설정됩니다.
Google에서 서비스에 API 액세스가 사용 설정되었다고 알린 후 OAuth를 사용하여 API에 액세스할 수 있습니다.
OAuth 2.0 사용
API에 액세스하려면 애플리케이션이
서비스 계정에서 생성된 이메일 주소와 비공개 키를 사용합니다. Google의
인증 메커니즘이 이 키를 OAuth 2.0 액세스 토큰으로 교환합니다.
앱의 API 호출에서 Authorization
헤더를 전달합니다.
액세스 토큰 (Bearer 토큰이라고도 함)은 OAuth 2.0의 일부입니다. 있습니다. HTTP 헤더에 액세스 토큰을 지정하는 구문은 다음과 같습니다.
Authorization: Bearer *oauth2_access_token*
다음 예는 보고서 API:
GET /travelpartner/v2.0/42000042/reports/top_opportunity_7_day HTTP/1.1
Host: www.googleapis.com
Authorization: Bearer nd42.fdLSKkljD98344444444444lSDF42fdLSKkljD98344444444444lSDF42
Cache-Control: no-cache
액세스 토큰을 생성하려면 원하는 언어로 애플리케이션을 만드세요.
다음 예시에서는 Python으로 토큰을 생성합니다. 그런 다음
사용자의 요청에 Travel Partner API에 액세스할 때 Authorization
헤더.
#!/usr/bin/python2.7
#
""" Sample code to get an auth header that you can use in your HTTP requests
1. Please see https://developers.google.com/api-client-library/python/start/installation
to download and install the google-api-python-client package.
2. Edit lines below marked _SERVICE_ACCOUNT, _KEY_FILE, _PARTNER_NAME,
and _API_VERSION.
3. Run the program using: "python sample.py". The app returns the value that
you use for the Authorization header's Bearer token in your request.
4. Copy the token and use it in requests to the Travel Partner API.
For example (2.0):
https://www.googleapis.com/travelpartner/2.0/42000042/reports/budget
For example (1.x):
https://www.googleapis.com/travelpartner/1.2/reports?report_type=BUDGET
"""
import httplib2
import json
import os
import sys
import urllib
HAS_CRYPTO = False
from apiclient import discovery
from oauth2client.client import flow_from_clientsecrets
try:
# Some systems may not have OpenSSL installed so can't use SignedJwtAssertionCredentials.
from oauth2client.client import SignedJwtAssertionCredentials
HAS_CRYPTO = True
except ImportError:
print "Unable to import SignedJwtAssertionCredentials"
from oauth2client import tools
from oauth2client.file import Storage
# Authorization scope for our requests (do not change)
_DEFAULT_APISCOPE = 'https://www.googleapis.com/auth/travelpartner'
# Use the service account you set up in the Google Developers Platform.
# It will be of the form "gsaccount_name@project_name.google.com.iam.gserviceaccount.com".
_SERVICE_ACCOUNT = ('myserviceaccount@my-hotel-project.google.com.iam.gserviceaccount.com')
# Set this to the full path to your service account's private binary .p12 key file
# that you downloaded from the Google Developer's Console and stored in a secure place.
# DO NOT use the json version of the certificate.
_KEY_FILE = '../mylocaldir/api-keys/8482bb2bdb08.p12'
# Set this to the case-sensitive "Partner Key", NOT the account
# name in the Hotel Ads Center or the numeric partner ID.
# Check with your TAM if you do not know your "Partner Key" name.
_PARTNER_NAME = 'testpartner2'
class HotelAdsAPIConnection(object):
def __init__(self, service_account=_SERVICE_ACCOUNT, key=_KEY_FILE, partner=_PARTNER_NAME):
self.key_file = key
self.account = service_account
self.partner = partner
def InitializeCredentials(self, scope):
'''Get credentials for use in API requests.
Generates service account credentials if the key file is present,
and regular user credentials if the file is not found.
'''
if os.path.exists(self.key_file):
if not HAS_CRYPTO:
raise Exception("Unable to use cryptographic functions "
+ "Try installing OpenSSL")
with open (self.key_file, 'rb') as file:
key = file.read();
creds = SignedJwtAssertionCredentials(self.account, key, scope)
self.credentials = creds
def authorize(self):
'''Construct a HTTP client that uses the supplied credentials.'''
return credentials.authorize(httplib2.Http())
def print_creds(self):
'''Prints the Authorization header to use in HTTP requests.'''
cred_dict = json.loads(self.credentials.to_json())
if 'access_token' in cred_dict:
print 'Authorization: Bearer %s' % (cred_dict['access_token'],)
else:
print 'creds: %s' % (cred_dict,)
def GetConnection(self):
http = httplib2.Http()
self.credentials.refresh(http)
http = self.credentials.authorize(http)
self.print_creds()
return http
def main(args):
# Create an instance of the HotelAdsAPIConnection inner class
api = HotelAdsAPIConnection()
# Generate credentials
api.InitializeCredentials(_DEFAULT_APISCOPE)
# Output the Authorization header to use in HTTP requests
api.GetConnection()
if __name__ == "__main__":
main(sys.argv)</pre>
애플리케이션을 개발할 때 권장사항을 따르세요. 안전하게 사용할 수 있습니다.
샘플 Python 스크립트는 Authorization
헤더의 Bearer를 출력합니다.
토큰의 값을 다음과 같이 바꿉니다.
$ python sample.py Authorization: Bearer ya29.42424242sample_420icu8122KSvoh4T42cRoG3rW1lc0Q $
요청에 토큰의 값을 사용합니다. 상담 후 1시간 동안은 좋습니다. 생성합니다.
문제 해결
문제가 발생했나요? 다음 항목을 빠르게 확인하면 문제가 해결될 수 있습니다. 있습니다.
- Google Developer Console에서 프로젝트를 만드셨나요?
- Travel Partner API을(를) 찾아서 사용 설정하셨나요?
- 클릭한 후 비공개 키인
.p12
파일을 다운로드하셨나요? 클라이언트 ID를 만들고 서비스 계정을 선택하시겠어요? - 다음 양식의 서비스 계정 클라이언트 ID 이메일 주소를 받았나요?
nnnnnnn@app_name.google.com.iam.gserviceaccount.com
인가요? - 다음을 클릭하여 호텔 광고 센터 계정을 서비스 계정과 공유했나요? 이 계정을 공유 버튼을 클릭하시겠습니까?
- 서비스 계정의 이메일 주소와 파트너 ID를 담당 기술계정 관리자 (TAM)에게 문의하셨나요?
- Travel Partner API 호출이
Authorization
헤더? Authorization
헤더의 Bearer 토큰이 1시간 이상 지났나요?
다음 표에는 몇 가지 일반적인 오류와 가능한 해결 방법이 나와 있습니다.
오류 | 설명 |
---|---|
Invalid credentials | 이는 다양한 상황을 의미할 수 있습니다. 이 오류가 발생하면 다음을 확인하세요.
<ph type="x-smartling-placeholder">
|
Not found | 엔드포인트의 형식이 잘못되었을 가능성이 높습니다. 먼저
GET 요청이며 요청 URL이 유효한지, 즉
를 추가하는 것이 좋습니다. |
Invalid string value | 엔드포인트의 하나 이상의 부분에 잘못된 구문이 포함되어 있습니다. 예를 들어 경로 일부의 철자를 틀렸을 수 있습니다. 올바른 밑줄, 대소문자, 문구를 사용하세요. |
Unsupported output format | 이 오류는 Reports API를 사용할 때 가장 흔히 발생합니다. 다음을 수행해야 합니다.
GET 의 URL에 "alt=csv" 를 지정합니다.
합니다. Reports API는 JSON을 지원하지 않습니다. |
AccessTokenRefreshError/Invalid grant | 샘플 Python 앱을 실행할 때 이 오류는 다음과 같은 이유로 발생할 수 있습니다.
다음 중 하나입니다.
<ph type="x-smartling-placeholder">
|
HotelAdsAPIConnection object has no attribute credentials | 샘플 Python 앱을 실행할 때 .p12 의 경로
파일이 올바르지 않습니다. |
Invalid scope | 샘플 Python 앱 실행 시 API 범위는
https://www.googleapis.com/auth/travelpartner |
Forbidden | 사용하는 계정 ID가 승인되지 않은 계정 ID입니다. 액세스할 수 있습니다. 하위 계정 소유자인 경우 상위 또는 루트 계정 ID입니다. |