From 1ed2d88d8b7aac41ffeda1f70da886de4f491ae0 Mon Sep 17 00:00:00 2001 From: hyeonjeongs Date: Sun, 11 Feb 2024 01:05:45 +0900 Subject: [PATCH] YEL-213 [feat] adoc build --- .../resources/static/docs/reward-admob.html | 583 ++++++++++++++++++ 1 file changed, 583 insertions(+) create mode 100644 src/main/resources/static/docs/reward-admob.html diff --git a/src/main/resources/static/docs/reward-admob.html b/src/main/resources/static/docs/reward-admob.html new file mode 100644 index 00000000..42d12596 --- /dev/null +++ b/src/main/resources/static/docs/reward-admob.html @@ -0,0 +1,583 @@ + + + + + + + +이벤트 참여 + + + + + +
+
+

이벤트 참여

+
+
+

요청

+
+
+
POST /api/v1/admob/reward HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Authorization: Bearer your-access-token
+IdempotencyKey: 87552f7c-9b62-4b12-b567-1bd062b09288
+Content-Length: 134
+
+{
+  "rewardType" : "ADMOB_POINT",
+  "randomType" : "FIXED",
+  "uuid" : "87552f7c-9b62-4b12-b567-1bd062b09288",
+  "rewardNumber" : 10
+}
+
+
+
+
+

request body

+
+
    +
  • +

    "rewardType": String → "ADMOB_POINT" | "ADMOB_MULTIPLE_POINT"

    +
    +
      +
    • +

      ADMOB_POINT : 광고 보고 10 포인트

      +
      • +
    • +

      ADMOB_MULTIPLE_POINT : 광고 보고 포인트 2배 이벤트

      +
      • +
    +
    +
    • +
  • +

    "randomType" : String → "FIXED" | "ADMOB_RANDOM"

    +
    +
      +
    • +

      FIXED : 고정값 (현재 이것만 사용)

      +
      • +
    • +

      ADMOB_RANDOM : 랜덤값 (추후 랜덤으로 바뀔 것 고려)

      +
      • +
    +
    +
    • +
  • +

    "uuid" : String → UUID4 형식만 적용

    +
    • +
  • +

    "rewardNumber" : Integer → 포인트인 경우 10, 투표 포인트 2배 이벤트인 경우 현재 투표 후 받은 포인트 보내줘야함

    +
    • +
+
+
+
+

응답

+
+
+
HTTP/1.1 200 OK
+Vary: Origin
+Vary: Access-Control-Request-Method
+Vary: Access-Control-Request-Headers
+Content-Type: application/json
+
+{
+  "status" : 201,
+  "message" : "Admob 광고 보고 보상받기에 성공했습니다.",
+  "data" : {
+    "rewardTag" : "ADMOB_POINT",
+    "rewardValue" : 10,
+    "rewardTitle" : "10 포인트를 얻었어요!",
+    "rewardImage" : "https://storage.googleapis.com/yelloworld/image/ticket-reward.svg"
+  }
+}
+
+
+
+
+

NOTE

+
+
    +
  • +

    Header에 무작위한 UUID4 값을 넣어주세요

    +
    +
      +
    • +

      예시) IdempotencyKey: 0397b5f3-ecdc-47d6-b5d7-2b1afcf00e87

      +
      • +
    +
    +
    • +
  • +

    주의사항

    +
    +
      +
    • +

      같은 멱등성키를 2번 요청하면, 400번 에러.

      +
      • +
    +
    +
    • +
  • +

    ADMOB

    +
    +
      +
    • +

      ADMOB 서버에 SSV(ServerSideVerification) Options의 customData에 입력한 것과 동일한 멱등성 키를 넘겨주세요.

      +
      • +
    +
    +
    • +
+
+
+
+

CHANGELOG

+
+
    +
  • +

    2024.02.11 릴리즈

    +
    • +
+
+
+
+
+
+ + + \ No newline at end of file