푸시 알림

작동 방식

웹샵 솔루션에서 푸시 알림을 설정할 수 있습니다. 푸시 알림은 사용자가 브라우저에서 직접 받는 개인 또는 대량 메시지입니다. 푸시 알림을 통해 사용자에게 새로운 아이템, 프로모션, 특별 혜택에 대해 알릴 수 있습니다.

예를 들어, 전투에서 패배하거나 자원이 부족할 때 사용자에게 알림을 보내려면 게임 서버 측에서 알림 전송을 위한 엑솔라 API를 호출하세요.

사용자가 알림을 클릭하면 웹샵 솔루션으로 이동하여 필요한 아이템을 구매할 수 있습니다.

푸시 알림은 엑솔라 웹사이트 빌더에서 구성되며, 게시된 웹샵 솔루션에서만 작동합니다.

엑솔라는 인게임 이벤트를 추적하지 않습니다. 게임 서버가 알림을 보내기 위해 API 호출을 수행할 시점을 정의할 수 있습니다. 예를 들어:

상호작용 절차

1. 사용자가 브라우저 또는 설치된 PWA를 통해 웹샵 솔루션을 열고 알림 구독을 제안하는 배너를 봅니다.
2. 사용자가 구독을 클릭하고 브라우저의 시스템 프롬프트에서 알림을 허용합니다.

    flowchart LR
      A[User opens Web Shop] --> B{Permission already granted?}
      B -- Yes --> C[Automatic subscription]
      B -- No --> D{Can the browser show the system prompt?}
      D -- Yes --> E[System prompt]
      D -- No --> F[Subscribe banner]
      F --> E
      E -- Allow --> G[Subscribed]
      E -- Block --> H[Not subscribed]
  

3. 웹샵 솔루션은 사용자를 엑솔라 시스템의 구독자로 등록합니다. 구독은 사용자의 장치에 있는 브라우저 또는 설치된 PWA에 연결됩니다. 사용자에게 보낼 수 있는 알림은 인증 상태에 따라 다릅니다.

   • 사용자가 웹샵 솔루션에 로그인한 경우, 사용자 ID가 구독에 연결됩니다. 이 사용자에게 개인 알림을 보낼 수 있습니다.
   • 사용자가 로그인하지 않은 경우, 대량 알림만 보낼 수 있으며, 사용자가 로그인하면 구독이 자동으로 사용자 ID에 연결됩니다.

4. 게임 서버가 알림을 보내기 위해 엑솔라 API를 호출합니다.

5. 사용자가 푸시 알림을 받습니다.

6. 사용자가 알림을 클릭하면 data.url 매개 변수에 지정된 페이지로 이동하거나 매개 변수가 전달되지 않은 경우 웹샵 솔루션의 메인 페이지로 이동합니다. 사용자가 웹샵 솔루션에서 활성 세션을 보유한 경우, 로그인 상태가 유지됩니다.

  sequenceDiagram
    participant U as User
    participant WS as Web Shop
    participant G as Game
    participant X as Xsolla
    note over U,X: Subscription
    U->>WS: Opens the site / PWA
    WS->>U: Displays the subscription banner
    U->>WS: Subscribes and allows notifications
    WS->>X: Registers the subscriber (User ID, browser / PWA)
    X-->>WS: Confirms the subscription
    note over U,X: Sending a notification
    G->>X: Calls POST /messages/push/send
    X-->>G: Returns message_id
    X->>U: Sends the push notification
    U->>WS: Clicks the notification, follows data.url
    WS->>U: Displays store offers

설정 방법

3. 푸시 알림 섹션으로 이동합니다.
4. 알림 활성화 토글을 켭니다.
5. 애플리케이션 ID, 클라이언트 ID, 클라이언트 비밀 키 입력란의 값을 복사합니다. 이는 게임 서버에서 API 요청을 보낼 때 필요합니다. 이 매개 변수는 알림 활성화 토글이 처음 켜질 때 한 번 생성되며, 전체 프로젝트에서 사용됩니다. 프로젝트에 여러 사이트가 있는 경우, 동일한 값이 모두 사용됩니다.
6. 필요에 따라 정기 결제 배너를 설정합니다. 제목, 설명, 아이콘, 버튼 텍스트를 변경할 수 있습니다.
7. 사이트가 열릴 때 푸시 알림 전송에 대한 사용자의 권한을 자동으로 요청하려면 자동 요청 권한 토글을 켭니다(선택 사항). 토글이 꺼져 있으면 사용자가 정기 결제 버튼을 클릭한 후에만 권한이 요청됩니다.
8. 변경 사항을 적용하려면 사이트를 게시합니다.

9. 게임 서버에서 푸시 알림 전송 로직을 구현합니다. 게임 서버는 알림을 보내기 위해 API 호출을 수행하고 요청에서 사용자 ID를 전달해야 합니다.

알림 전송

엑솔라는 알림을 자동으로 보내지 않습니다. 항상 게임 서버에서 API 호출을 통해 전송이 시작됩니다.

기본 URL: https://messaging-platform.xsolla.com

인증

요청은 OAuth 2.0 프로토콜을 통해 인증됩니다. 다음 매개 변수를 전달하여 JWT 생성 API 호출을 통해 서버 JWT를 받으세요.

• grant_type - JWT 부여 유형, client_credentials 값을 전달합니다.
• client_id - 푸시 알림 섹션 설정의 클라이언트 ID 입력란 값
• client_secret - 푸시 알림 섹션 설정의 클라이언트 비밀 키 입력란 값

받은 토큰을 Authorization: Bearer <token> 헤더에 전달합니다.

사용자에게 알림 전송

사용자의 ID를 통해 개인 푸시 알림을 보냅니다. 알림은 사용자가 알림을 구독한 모든 브라우저와 설치된 PWA에 전달됩니다.

HTTP 요청

POST https://messaging-platform.xsolla.com/api/v1/messages/push/send

요청 헤더

요청 매개 변수

응답 매개 변수

요청 예시

 1{
 2  "notification_type": "user_validation",
 3  "settings": {
 4    "project_id": 123456,
 5    "merchant_id": 789012
 6  },
 7  "user": {
 8    "id": "11111111-1111-1111-1111-111111111111"
 9  }
10}

응답 예시

1{
2  "message_ids": [
3"aa8ef5c2-front-4a3b-9d2e-example00001",
4"bb9fa6d3-front-4b4c-8e3f-example00002"
5    ]
6}

모든 사용자에게 알림 전송

설치 프로그램사용자 ID를 통해 개인 푸시 알림을 보냅니다. 알림은 사용자가 알림을 구독한 모든 브라우저와 설치된 PWA에 전달됩니다.

HTTP 요청

POST https://messaging-platform.xsolla.com/api/v2/messages/push/send_batch

요청 헤더

요청 매개 변수

응답 매개 변수

요청 예시

 1POST /api/v2/messages/push/send_batch HTTP/1.1
 2Host: messaging-platform.xsolla.com
 3Authorization: Bearer <token>
 4Idempotency-Key: 5c1f0d2a-9b7e-4f36-8a1d-example00002
 5Content-Type: application/json
 6
 7{
 8  "app_id": "your_app_id",
 9  "recipients": {
10    "type": "all"
11  },
12  "title": "Seasonal sale!",
13  "body": "Up to 50% off in the Web Shop until the end of the week."
14}

 1POST /api/v1/messages/push/send_batch HTTP/1.1
 2Host: messaging-platform.xsolla.com
 3Authorization: Bearer <token>
 4Idempotency-Key: 7d2e1f3b-8c6a-4e57-9b2f-example00003
 5Content-Type: application/json
 6
 7{
 8  "app_id": "your_app_id",
 9  "recipients": {
10    "type": "external_user_id",
11    "external_user_id": ["player_123", "player_456"]
12  },
13  "title": "Seasonal sale!",
14  "body": "Up to 50% off in the Web Shop until the end of the week."
15}

응답 예시

1{
2  "summary": {
3    "failed_count": 0,
4    "success_count": 20
5  }
6}

 1{
 2  "results": [
 3    {
 4      "message_id": "cc0ab7e4-front-4c5d-9f4a-example00003",
 5      "player_id": "player_123",
 6      "status": "success"
 7    },
 8    {
 9      "message_id": "dd1bc8f5-front-4d6e-8a5b-example00004",
10      "player_id": "player_456",
11      "status": "success"
12    }
13  ]
14}