콘텐츠로 건너뛰기
/
프로모션에 캠페인 연결

정기 결제 API (2.0)

개요

  • 버전: 2.0
  • 서버: https://api.xsolla.com/merchant/v2/

본 API 참조는 정기 결제, 쿠폰 및 프로모션 관리 엔드포인트에 관하여 기술하고 있습니다. 정기 결제에 대한 더 자세한 내용은 제품 가이드 및 용어집을 참조하십시오.

OpenAPI 설명 다운로드
index.json
index.yaml
언어
서버
Mock server
https://xsolla.redocly.app/_mock/ko/api/subscriptions/

토큰

작업

Plans

작업

제품

작업

Subscription management

작업

결제

작업

프로모션

작업

쿠폰

작업

캠페인에 쿠폰 추가

요청

쿠폰 캠페인에 쿠폰 코드를 추가합니다.

주의

이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.

보안
basicAuth
경로
merchant_idinteger필수

판매자 ID입니다.

campaign_idinteger필수

Campaign ID.

본문application/json필수
coupon_codestring필수

Coupon code.

예제: "34bryrb3"
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ko/api/subscriptions/merchants/{merchant_id}/coupon_promotions/{campaign_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "34bryrb3"
  }'

응답

콘텐츠가 없습니다.

프로모션에 캠페인 연결

요청

특정 프로모션에 쿠폰 캠페인을 첨부합니다.

주의

이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.

보안
basicAuth
경로
merchant_idinteger필수

판매자 ID입니다.

promotion_idinteger필수

프로모션 ID입니다.

본문application/json필수
campaignsArray of integers필수

캠페인 ID 배열입니다.

예제: [9135]
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ko/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaigns": [
      9135
    ]
  }'

응답

콘텐츠가 없습니다.

쿠폰 가져오기

요청

Get coupon details by its code.

보안
basicAuth
경로
project_idinteger필수

Project ID.

codestring필수

Coupon code.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ko/api/subscriptions/projects/{project_id}/coupons/{code}/details'

응답

OK(확인).

본문application/json
keystring

Key of the user attribute.

list_of_valuesArray of objects

enum형 값의 배열입니다.

nameobject

Localized attribute names.

skip_condition_on_nonexistent_keyboolean

키가 존재하지 않는 경우 조건을 건너뛰어야 하는지 여부입니다.

typestring

키 유형입니다.

열거형"int""string""enum""date"
visibleboolean
응답
application/json
{
  "key": "12",
  "list_of_values": [],
  "name": {
    "en": "Level",
    "ru": "Уровень"
  },
  "skip_condition_on_nonexistent_key": true,
  "type": "int",
  "visible": false
}

Subscription management

작업