웹훅 설정

웹훅은 시스템에서 발생하는 이벤트에 대한 알림입니다. 특정 이벤트가 발생하면 엑솔라는 이벤트 데이터가 전송되는 HTTP 요청을 애플리케이션으로 보냅니다. 이는 일반적으로 JSON 형식의 POST 요청입니다.

이벤트 예시:

• 아이템 카탈로그를 사용하는 사용자 상호 작용
• 결제 또는 주문 취소

웹훅 목록

인게임 스토어를 제대로 운영하려면 메인 웹훅 처리를 구현해야 합니다:

• 결제 — 주문이 결제되면 전송되며 결제 데이터 및 거래 세부 정보가 포함됩니다.
• 주문 결제 성공 — 결제 웹훅이 성공적으로 처리되었을 때 전송되었으며 여기에는 구매한 아이템 및 거래 ID에 대한 정보를 포함되어 있습니다. 사용자에게 아이템을 추가할 때 웹훅 데이터를 사용할 수 있습니다.
• 환불 — 주문이 취소되면 전송되며 취소된 결제 데이터 및 거래 세부 정보가 포함됩니다.
• 주문 취소 — 환불 웹훅이 성공적으로 처리되었을 때 전송되며, 구매 아이템에 대한 정보와 취소된 거래의 ID가 포함되어 있습니다. 웹훅의 데이터를 사용하여 구매한 아이템을 제거합니다.

• 사용자 유효성 검사 — 사용자가 게임에 등록되어 있는지 확인하기 위해 결제를 처리하는 여러 단계에서 전송됩니다.

다음은 이 목록의 웹훅을 사용하여 웹사이트에서 제품을 구매하고 반품하는 방식입니다.

아이템 카탈로그 개인 설정을 애플리케이션 측에서 구현한 경우 파트너 측에서 카탈로그 개인 설정 처리를 설정합니다.

관리자 페이지에서 웹훅 설정하기

웹훅 수신을 활성화하는 방법:

1. 관리자 페이지에서 프로젝트를 엽니다.
2. 사이드 메뉴에서 프로젝트 설정을 클릭하고 웹훅 탭으로 이동합니다.
3. 웹훅 서버 필드에서 https://example.com 형식으로 웹훅을 수신할 서버의 URL을 지정합니다. 웹훅 테스트용 도구에서 확인한 URL을 지정할 수도 있습니다.

4. 프로젝트 웹훅에 서명하기 위한 비밀 키가 기본적으로 생성됩니다. 새 비밀 키를 생성하려면 새로 고침 아이콘을 클릭합니다.
5. 웹훅 활성화를 클릭합니다.

1. 관리자 페이지에서 프로젝트를 엽니다.
2. 사이드 메뉴에서 프로젝트 설정을 클릭하고 웹훅 솔루션 탭으로 이동합니다.
3. 웹훅 비활성화를 클릭합니다.

관리자 페이지에서 웹훅 테스트하기

다음 웹훅 수신을 테스트할 수 있습니다.

웹훅이 성공적으로 설정되면 웹훅 설정 블록 아래에 웹훅 테스트 블록이 표시됩니다.

• 스토어
• 페이먼트 솔루션

스토어 탭에서 다음 웹훅을 테스트할 수 있습니다.

• 주문 결제 성공(order_paid)
• 주문 취소(order_canceled)

테스트 방법:

1. 웹훅 테스트 블록에서 스토어 탭으로 이동합니다.
2. 드롭다운 메뉴에서 아이템 유형을 선택합니다. 선택한 아이템 유형이 관리자 페이지에 설정되어 있지 않은 경우 다음을 클릭합니다.
   • 연결 - 이 유형의 아이템이 있는 모듈이 연결되어 있지 않은 경우
   • 구성 - 이전에 모듈을 연결했지만 설정을 완료하지 않은 경우

1. 버튼을 클릭하면 선택한 아이템 유형에 해당하는 관리자 페이지 섹션으로 리디렉션됩니다. 아이템을 생성하면 웹훅 테스트 섹션으로 돌아가 다음 단계를 진행합니다.

3. 엑솔라 주문 ID 필드에 값을 입력합니다.
4. 드롭다운 목록에서 아이템의 SKU를 선택한 후 수량을 지정합니다. +를 클릭하고 새 행에 아이템을 추가하여 동일한 유형의 아이템을 여러 개 선택할 수 있습니다.
5. 주문 결제 시 사용할 통화를 선택합니다.
6. 테스트를 클릭합니다.

지정된 데이터가 포함된 주문 결제 성공 및 주문 취소 웹훅이 제공된 URL로 전송됩니다. 각 웹훅 유형을 테스트한 결과는 테스트 버튼 아래에 표시됩니다.

알림

테스트 블록에 테스트를 통과하지 못했다는 오류 메시지가 표시되면 웹훅 수신기의 웹훅 응답 설정을 확인합니다. 이러한 오류에 대한 정보는 테스트 결과에서 확인할 수 있습니다.

페이먼트 솔루션 탭에서 다음 웹훅을 테스트할 수 있습니다.

• 사용자 유효성 검사 (user_validation)
• 결제(payment)

테스트하는 방법:

1. 테스트 섹션에서 페이먼트 솔루션 탭으로 이동합니다.
2. 필수 필드에 값을 입력합니다.
   • 사용자 ID - 테스트 시 임의의 문자와 숫자 조합을 사용할 수 있습니다.
   • 공개 사용자 ID - 이메일이나 닉네임 등 사용자에게 알려진 ID를 입력합니다. 이 필드는 프로젝트에서 공개 사용자 ID가 활성화된 경우 페이 스테이션 > 설정 > 추가 설정 섹션에 표시됩니다.
   • 통화 - 드롭다운 목록에서 통화를 선택합니다.
   • 엑솔라 인보이스 ID - 엑솔라 측의 트랜잭션 ID입니다. 테스트 시 임의의 값을 사용할 수 있습니다.
   • 금액 - 결제 금액입니다. 테스트 시 임의의 값을 사용할 수 있습니다.
   • 인보이스 ID - 게임 측의 트랜잭션 ID입니다. 테스트 시 임의의 문자와 숫자를 조합하여 사용할 수 있습니다. 성공적인 결제에 필수적인 매개 변수는 아니지만 엑솔라 측의 트랜잭션 ID에 자신의 트랜잭션 ID를 연결하기 위해 전달할 수 있습니다.
3. 웹훅 테스트를 클릭합니다.

지정된 URL로 데이터가 입력된 웹훅을 받게 됩니다. 성공한 시나리오와 오류가 발생한 시나리오 모두에 대한 각 웹훅의 테스트 결과는 웹훅 테스트 버튼 아래에 표시됩니다. 프로젝트에서 공개 사용자 ID가 활성화한 경우 사용자 검색 확인 결과도 표시됩니다.

각 웹훅이 성공 시나리오와 오류가 발생한 시나리오를 모두 처리하도록 구성해야 합니다.

웹훅 서버 필드에 URL을 저장하면 웹훅에서 자세한 정보를 수신할 권한을 부여할 수 있는 고급 설정 섹션을 볼 수 있습니다. 이렇게 하려면 각 토글을 온으로 설정합니다. 각 권한의 줄에서 해당 설정의 영향을 받는 웹훅 목록을 확인할 수 있습니다.

웹훅 수신기

웹훅 수신기는 지정된 URL 주소에서 들어오는 웹훅을 수신하고 서명을 생성한 후 엑솔라 웹훅 서버로 응답을 전송할 수 있는 프로그램 코드입니다.

서명 생성

웹훅을 수신할 때는 데이터 전송의 보안을 보장해야 합니다. 이를 위해서는 웹훅 데이터에서 서명을 생성하고 생성된 서명이 HTTP 요청 헤더에 전송된 서명과 일치하는지 확인해야 합니다.

서명 생성 방법:

1. 요청 본문과 프로젝트의 비밀 키의 JSON을 연결합니다.
2. 첫 번째 단계에서 구한 문자열에 SHA-1 암호화 해시 함수를 적용합니다.

웹훅으로 응답 보내기

웹훅 수신을 확인하려면 서버가 다음을 반환해야 합니다.

• 성공적인 응답의 경우 200, 201 또는 204 HTTP 코드
• 지정된 사용자를 찾을 수 없거나 잘못된 서명이 전달된 경우 문제 설명이 포함된 400 HTTP 코드

서버에 일시적인 문제가 발생한 경우 웹훅 핸들러가 5xx 코드를 반환할 수도 있습니다.

주문 결제 성공 및 주문 취소 웹훅에 대한 응답을 받지 못했거나 5xx 코드가 포함된 응답을 받은 경우, 다음 일정에 따라 웹훅이 다시 전송됩니다.

• 5분 간격으로 2번
• 15분 간격으로 7번
• 60분 간격으로 10번

웹훅 전송은 처음 시도 후 12시간 이내에 최대 20번까지 시도할 수 있습니다.

결제 웹훅에 대한 응답이 수신되지 않았거나 5xx 코드가 포함된 응답이 수신된 경우 웹훅도 증가된 시간 간격으로 재전송됩니다. 12시간 동안 최대 12번 시도할 수 있습니다.

사용자 유효성 검사 웹훅에 대한 응답이 수신되지 않았거나 400 또는 5xx 코드가 포함된 응답이 수신된 경우 사용자 유효성 검사 웹훅이 재전송되지 않습니다.

이 경우 사용자에게 오류가 표시되며 결제와 주문 결제 성공 웹훅은 전송되지 않습니다.