Actions Center에서 나를 대신하여 예약을 생성하고 업데이트하기 위한 콜백을 수행할 수 있도록 예약 서버를 설정해야 합니다.
- 표준 구현. 이렇게 하면 Actions Center가 사용자를 대신하여 개발자와 약속, 예약을 생성할 수 있습니다.
샌드박스 및 프로덕션 예약 서버에 대한 연결을 구성하는 방법에 대한 자세한 내용은 파트너 포털 문서를 참고하세요.
REST API 인터페이스 구현
REST를 기반으로 API 인터페이스를 구현합니다. 이렇게 하면 Google에서 HTTP를 통해 예약 서버 요청을 전송할 수 있습니다.
시작하려면 작업 센터 샌드박스 환경에 연결할 수 있는 개발 또는 샌드박스 예약 서버를 설정하세요. 샌드박스 서버가 완전히 테스트된 후에만 프로덕션 환경으로 이동합니다.
방법
예약 서버 유형마다 서로 다른 API 메서드 집합이 필요합니다. 원하는 경우 proto 형식으로 서비스 정의를 다운로드하여 API 구현을 시작할 수 있습니다. 다음 표는 각 구현의 메서드를 보여주며 서비스 proto 형식 링크를 포함합니다.
표준 구현 |
---|
표준 서비스 정의 proto 서비스 정의 파일을 다운로드합니다. |
메서드 | HTTP 요청 |
---|---|
HealthCheck | GET /v3/HealthCheck/ |
BatchAvailabilityLookup | POST /v3/BatchAvailabilityLookup/ |
CreateBooking | POST /v3/CreateBooking/ |
UpdateBooking | POST /v3/UpdateBooking/ |
GetBookingStatus | POST /v3/GetBookingStatus/ |
ListBookings | POST /v3/ListBookings/ |
API 리소스
예약
표준 구현에서는 다음 리소스 유형이 사용됩니다.
과정: 예약 만들기
이 섹션에서는 표준 구현을 위한 예약을 만드는 방법을 설명합니다.
사용자가 예약을 만들면 Google에서 사용자의 이름, 성, 전화번호, 이메일을 전송합니다. 이 예약은 작업 센터에서 시스템의 사용자 계정을 조회할 수 없으므로 비회원 결제로 취급해야 합니다. 최종 예약이 예약 시스템에서 오는 판매자의 예약과 동일하게 표시되는지 확인합니다.
보안 및 인증
예약 서버와의 모든 통신은 HTTPS를 통해 이루어지므로 DNS 이름과 일치하는 유효한 TLS 인증서가 서버에 있어야 합니다. 서버 설정에 도움이 되도록 Qualys SSL 서버 테스트와 같이 공개적으로 사용 가능한 SSL/TLS 확인 도구를 사용하는 것이 좋습니다.
Google에서 예약 서버에 전송하는 모든 요청은 HTTP 기본 인증을 사용하여 인증됩니다. 예약 서버의 기본 사용자 인증 정보(사용자 이름 및 비밀번호)는 파트너 포털 내 예약 서버 구성 페이지에 입력할 수 있습니다. 비밀번호는 6개월마다 순환되어야 합니다.
샘플 스켈레톤 구현
시작하려면 Node.js 및 자바 프레임워크용으로 작성된 예약 서버의 다음 샘플 스켈레톤을 확인하세요.
- Node.js 스켈레톤 js-maps-booking-rest-server-v3-skeleton
- 자바 스켈레톤 java-maps-booking-rest-server-v3-skeleton
이 서버는 REST 메서드를 스터브 처리했습니다.
요구사항
HTTP 오류 및 비즈니스 로직 오류
백엔드가 HTTP 요청을 처리하면 두 가지 유형의 오류가 발생할 수 있습니다.
- 인프라 또는 잘못된 데이터 관련 오류
- 이러한 오류를 표준 HTTP 오류 코드와 함께 클라이언트에 반환합니다. 전체 HTTP 상태 코드 목록을 참고하세요.
- 비즈니스 로직과 관련된 오류
200
OK로 설정된 HTTP 상태 코드를 반환하고 응답 본문에 비즈니스 로직 실패를 지정합니다. 발생할 수 있는 비즈니스 로직 오류의 유형은 서버 구현 유형에 따라 다릅니다.
표준 구현의 경우 가능한 비즈니스 로직 오류는
예약 실패에서 캡처되며
HTTP 응답으로 반환됩니다. 리소스를 만들거나 업데이트할 때 비즈니스 로직 오류가 발생할 수 있습니다. 예를 들어 CreateBooking
또는 UpdatingBooking
메서드를 처리할 때. 여기에 해당되는 예는 다음과 같으나 이에 국한되지는 않습니다.
- 요청된 시간대를 더 이상 사용할 수 없는 경우
SLOT_UNAVAILABLE
가 사용됩니다. - 제공된 신용카드 유형이 허용되지 않는 경우
PAYMENT_ERROR_CARD_TYPE_REJECTED
가 사용됩니다.
멱등성
네트워크를 통한 통신이 항상 신뢰할 수 있는 것은 아니며 응답이 수신되지 않으면 Google에서 HTTP 요청을 다시 시도할 수 있습니다. 따라서 상태를 변경하는 모든 메서드는 멱등성을 가져야 합니다.
CreateBooking
UpdateBooking
UpdateBooking
를 제외한 모든 요청 메시지에 멱등성 토큰이 포함되어 요청을 고유하게 식별합니다. 이렇게 하면 단일 요청을 만들기 위한 인텐트와 두 개의 개별 요청을 사용하여 재시도된 REST 호출을 구분할 수 있습니다.
UpdateBooking
는 예약 항목 ID로 각각 고유하게 식별되므로 요청에 멱등성 토큰이 포함되지 않습니다.
다음은 예약 서버가 멱등성을 처리하는 방법의 몇 가지 예입니다.
성공적인
CreateBooking
HTTP 응답에는 생성된 예약이 포함됩니다. 경우에 따라 결제가 예약 과정에서 처리될 수 있습니다. 정확히 동일한CreateBookingRequest
가 두 번째로 수신되면 (동일한idempotency_token
포함) 동일한CreateBookingResponse
이 반환되어야 합니다. 두 번째 예약은 생성되지 않으며 해당하는 경우 사용자에게 정확히 한 번 청구됩니다.CreateBooking
시도가 실패하고 동일한 요청이 다시 전송되면 백엔드가 이를 다시 시도해야 합니다.
멱등성 요구사항은 상태를 변경하는 모든 메서드에 적용됩니다.