정기 결제 정보 가져오기

웹샵 솔루션에서 정기 결제을 판매하려는 경우, 다음의 방법으로 정기 결제 작업에 대한 정보 수신을 구현합니다:

• API를 통해 (서버리스 통합용으로 적합)
• 웹훅을 통해 (자동 알림으로, 서버 통합용으로 적합)

API 호출을 통한 설정

애플리케이션의 클라이언트 측에서 HTTP GET 요청을 사용하여 사용자 정기 결제 정보 가져오기를 구현합니다.

엑솔라 API는 HTTP 액세스 인증을 사용합니다. 요청은 반드시 헤더Authorization: Bearer <client_user_jwt>를 포함해야 하며, <client_user_jwt>는 Base64 표준에 따라 인코딩된 고유 토큰이어야 합니다. 이를 얻으려면:

• 로그인 및 암호로 인증하는 경우 Register new user 밒 Auth by username and password API 호출을 사용합니다.
• 소셜 네트워크를 통해 인증하는 경우 Auth via social network API 호출을 사용합니다.

프로젝트 ID를 매개 변수projectId로 지정합니다. 이 매개 변수는 게시자 게정의 프로젝트 이름 옆에서 찾을 수 있습니다. 쿼리 매개 변수로 지정:

• limit — 페이지의 요소 개수에 대한 제한 (기본적으로 15개 요소가 표시됩니다).
• offset — 목록이 생성된 요소의 개수 (0부터 카운트됩니다).
• locale — 인터페이스 언어(기본적으로 영어로 설정됩니다). ISO 639-1 표준에 따른 값을 수락합니다.

-X 'GET' \
  'https://subscriptions.xsolla.com/api/user/v1/projects/{projectId}/subscriptions?locale=ru&limit=5&offset=5 ' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer client_user_jwt'

응답 예제:

{
  "items": [
    {
      "id": 11111111,
      "plan_id": 11111
      "plan_external_id": "TestChangePlanBase",
      "plan_name": "package_recurrent_name_66053",
      "plan_description": "package_recurrent_description_66053",
      "product_id": null,
      "product_external_id": null,
      "product_name": null,
      "product_description": null,
      "status": "active",
      "date_create": "2021-03-11T13:50:11+03:00",
      "date_next_charge": "2031-04-11T13:51:02+03:00",
      "date_last_charge": "2021-03-11T13:51:02+03:00",
      "charge": {
        "amount": "0.2500",
        "currency": "USD"
      },
      "period": {
        "value": 1,
        "unit": "day"
      }
    }
  ],
  "has_more": true
}

웹훅을 통한 설정

1. 웹훅 수신용 매개 변수를 구성합니다.
   1. 관리자 페이지에서 프로젝트를 엽니다.
   2. 사이드 메뉴에서 프로젝트 설정을 클릭하고 웹훅 솔루션 탭으로 이동합니다.
   3. 웹훅 서버 필드에서 https://example.com 형식으로 웹훅을 수신할 서버의 URL을 지정합니다. 웹훅 테스트용 도구에서 확인한 URL을 지정할 수도 있습니다.
   4. 프로젝트 웹훅에 서명하는 비밀 키는 기본값으로 생성됩니다. 새 비밀 키를 생성하려면 새로 고침 아이콘을 클릭합니다.
   5. 웹훅 사용을 클릭합니다.

2. 애플리케이션에서 다음 유형의 웹훅 처리를 구현합니다:
   • 정기 결제을 구매 및 갱신하려면:
     • 사용자 유효성 검사
     • 결제
     • 생성된 정기 결제
     • 업데이트된 정기 결제
   • 정기 결제을 취소하려면: 취소된 정기 결제
   • 환불하려면: 환불

3. 웹훅 테스트:
   1. 관리자 페이지의> 프로젝트 설정 > 웹훅에서, 정기 결제 탭으로 이동합니다.

2. 웹훅을 테스트하려면, 프로젝트의 값을 지정하여 (사용자 ID, 인보이스 ID) 귀하께서 제공한 웹훅 URL로 요청에서 전송합니다. 실제 값이 부재한 경우 임의의 값을 입력할 수 있습니다. 다음 양식 필드를 완료합니다:
   • 사용자 ID
   • 엑솔라 인보이스 ID
   • 금액
   • 통화
   • 요금제 ID
   • 정기 결제 상품(선택 사항)
   • 인보이스 ID — 내부 주문 번호(선택 사항)
   • 무료 체험 기간 (샌드박스 모드에서 정기 결제 구매 테스트 또는 구동 갱신 테스트를 하려면 0 값을 설정합니다.)

3. 테스트를 클릭합니다.
4. 테스트 성공 메시지를 받았는지 확인합니다. 테스트가 성공적이라면, 귀하의 서버는 반드시 다음과 함께 응답해야 합니다:
   • 메시지 본문 없이 HTTP 코드 204.
   • 지정된 사용자를 찾을 수 없거나 잘못된 서명이 전달된 경우 문제를 설명하는 HTTP 코드 400 또는 500.

4. 남은 웹훅 수령 테스트:
   1. 샌드박스 모드를 사용해 정기 결제 구매 및 갱신을 테스트하고 생성된 정기 결제, 업데이트된 정기 결제, 및 취소된 정기 결제 웹훅을 얻습니다.
   2. 라이브 모드를 사용해 실제 결제에 대한 정기 결제 구매를 테스트하고 환불, 취소된 정기 결제 웹훅을 얻습니다.

다음 단계

1. 사용자 인증을 설정합니다.
2. 샌드박스 모드에서 웹샵 솔루션을 테스트합니다.

유용한 링크

통합 절차