주요 콘텐츠로 건너뛰기

쿠폰 등록 웹훅

Aghanim은 플레이어가 무료 아이템을 위한 리딤코드를 사용했을 때 게임에 알리고 해당 이벤트에 대한 자세한 정보를 제공하는 쿠폰 등록 웹훅을 제공합니다.

이 웹훅은 게임 → 웹훅에서 선택할 수 있는 Coupon redeemed 이벤트를 통해 활성화됩니다.

경고

플레이어 계정에 게임 내 아이템을 추가하려면 item.add 웹훅을 사용하세요. 쿠폰 등록 웹훅은 item.add로 충분하지 않을 때 자세한 데이터를 제공하도록 설계되었습니다.

Redeem coupon webhook image
Redeem coupon webhook image

요구 사항

Aghanim의 쿠폰 등록 웹훅을 사용하려면 웹훅 서버를 다음과 같이 구성해야 합니다:

  • POST 웹훅 요청을 수락하는 HTTPS 엔드포인트.
  • Aghanim이 생성하고 서명한 이벤트를 수신합니다.
  • 성공적으로 처리된 경우에는 2xx 상태 코드로 응답하며, 거부 또는 오류의 경우에는 4xx 또는 5xx를 응답합니다.

구성

  1. coupon.redeemed 웹훅 처리를 위한 함수를 개발합니다.
  2. 엔드포인트를 사용 가능하게 설정하세요.
  3. 해당 이벤트 유형을 선택하여 Aghanim 계정 내에서 엔드포인트를 등록합니다 → 게임 → 웹훅 → 새 웹훅

대안으로, 웹후크 생성 API 방법을 사용하여 Aghanim 내에서 엔드포인트를 등록할 수 있습니다.

요청 스키마

아래는 예시입니다 coupon.redeemed 웹훅 요청:

POST /your/webhook/uri HTTP/1.1
Content-Type: application/json
Host: your-webhook-endpoint.com
User-Agent: Aghanim/0.1.0
X-Aghanim-Signature: 2e45ed4dede5e09506717490655d2f78e96d4261040ef48cc623a780bda38812
X-Aghanim-Signature-Timestamp: 1725548450

{
  "event_type": "coupon.redeemed",
  "event_data": {
    "player_id": "2D2R-OP3C",
    "coupon": {
      "code": "WELCOME",
      "sku": "crystals",
      "redeemed_at": 1725548450
    },
    "item": {
      "id": "itm_exTBZQmIlDz",
      "name": "Crystals",
      "description": "Reign supreme over your rivals with this massive crystal treasure.",
      "sku": "crystals",
      "quantity": 480000,
      "price": 9499,
      "price_decimal": 94.99,
      "currency": "USD",
      "type": "item",
      "nested_items": null
    }
  },
  "event_time": 1725548450,
  "event_id": "whevt_eCacGbJVbvToOgzjXUgOCitkQE",
  "idempotency_key": "idmpt_aXRlb...JkX2VFS",
  "request_id": "d1593e9c-c291-4004-8846-6679c2e5810b",
  "sandbox": false,
  "trigger": "hub.redeem",
  "transaction_id": "whtx_eCacGbJVbvT",
  "context": null,
  "game_id": "gm_exTAyxPsVwh"
}

이벤트 스키마

Key유형설명
event_idstringAghanim에 의해 생성된 고유 이벤트 ID.
game_idstringAghanim 시스템에서의 귀하의 게임 ID.
event_typestring이벤트의 유형, coupon.redeemed 이럴 경우.
event_timenumber유닉스 에포크 시간으로 된 이벤트 날짜.
event_dataEventData이벤트 특정 데이터가 포함되어 있으며, 상속된 객체에 대한 가능한 키가 포함됩니다.
idempotency_keystring웹훅 작업이 재시도되어도 한 번만 실행되도록 보장합니다.
request_idstring|null이벤트가 API 요청에 의해 트리거된 경우, 요청 ID가 포함됩니다.
sandboxboolean이 이벤트가 샌드박스 게임 환경에서 전송되었는지를 표시합니다.
triggerstring|nullThe trigger that caused the event to be sent.
transaction_idstringAghanim이 생성한 거래 ID입니다. 이 ID는 동일한 거래 내에서 발생한 여러 이벤트에서 동일할 수 있습니다.
contextEventContext|null이벤트에 대한 컨텍스트 정보.

EventContext 스키마

Key유형설명
orderOrderContext|null해당되는 경우 이벤트와 관련된 주문 정보입니다.
playerPlayerContext|null플레이어 정보를 추가하려면 웹훅 설정에서 "플레이어 컨텍스트 추가"를 활성화하세요.

EventData 스키마

Key유형설명
player_id문자열플레이어 인증을 위해 선택된 고유한 플레이어 ID.
couponCoupon쿠폰 객체에 포함된 리딤코드 데이터입니다.
itemItem코드를 사용하면 제공되는 무료 품목에 대한 세부 정보가 포함된 품목 객체입니다.

쿠폰 객체

Key유형설명
code문자열리딤코드.
sku문자열리딤코드 사용 시 제공된 무료 아이템 SKU.
redeemed_atnumber유닉스 에포크 시간으로 된 코드 사용 날짜.

트리거 값

값설명
hub.redeem무료 아이템에 대한 쿠폰이 리딤되는 경우.
testDashboard에서 "Send test event"를 사용할 때.

아이템 스키마

KeyType설명
idstringAghanim에 의해 생성된 아이템 ID.
namestring아이템 이름.
descriptionstring|null아이템 설명.
skustring게임과 Aghanim 측 모두에서 일치하는 아이템 SKU.
quantitynumber아이템 수량.
typestring항목 유형. 가능한 값: item, bundle.
nested_itemsNestedItem[]|null번들에 포함된 항목 배열.
fallback_itemItem|null주 아이템을 플레이어에게 제공할 수 없을 경우 백업으로 제공할 수 있는 아이템입니다.
metadataobject|nullCustom key-value pairs for the item to support additional logic on your end.

항목 유형 bundle 내부에 여러 중첩된 항목을 포함할 수 있습니다.
번들의 공통 SKU를 처리하거나 각 중첩 항목을 개별적으로 처리할 수 있습니다.

NestedItem 스키마

Key유형설명
idstringAghanim에 의해 생성된 아이템 ID.
namestring아이템 이름.
descriptionstring|null아이템 설명.
skustring게임과 Aghanim 측 모두에서 일치하는 아이템 SKU.
quantitynumber아이템 수량.
fallback_itemItem|null주 아이템을 플레이어에게 제공할 수 없을 경우 백업으로 제공할 수 있는 아이템입니다.
metadataobject|nullCustom key-value pairs for the item to support additional logic on your end.

도움이 필요하세요?
통합팀에 문의하십시오 [email protected]

On this page