Создание каталога

Возможны следующие способы создания каталога подписок:

• в собственном интерфейсе;
• в платежном интерфейсе Иксолла;
• в конструкторе сайтов Иксолла.

В собственном интерфейсе

При создании каталога в собственном интерфейсе вы можете использовать:

• Собственное хранилище данных и любой вариант авторизации. В этом случае реализуйте отображение каталога на своей стороне.
• Собственную авторизацию и серверный метод Получение планов. После получения списка планов реализуйте отображение каталога на своей стороне.
• Авторизацию Иксолла и клиентские методы получения списка планов.

Авторизация Иксолла и клиентские методы

Для реализации каталога:

1. Получите список планов подписок с помощью клиентских методов:
   • если в вашем проекте настроены продукты подписки, используйте клиентский метод получения списка планов по продукту;
   • если в вашем проекте не настроены продукты подписки, используйте клиентский метод получения списка планов.
2. Реализуйте отображение полученного списка планов в интерфейсе.

Клиентский метод получения списка планов по продукту

В клиентской части вашего приложения реализуйте получение списка планов по продукту с использованием HTTP GET-запроса https://subscriptions.xsolla.com​/api/user/v1/projects/{project_id}/products/{​​productId}/plans.

Запрос к методу должен содержать заголовок Authorization: Bearer <client_user_jwt>, где <client_user_jwt> — JSON Web Token (JWT) пользователя — уникальный токен, закодированный по стандарту Base64. Используйте для его получения:

• Методы API Register new user и Auth by username, если в вашем приложении используется авторизация по логину и паролю.
• Метод API Auth via social network, если в вашем приложении используется авторизация через социальные сети.

В качестве path-параметра укажите:

• projectId — ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

• productID — ID продукта подписки. Для его получения обратитесь к аккаунт-менеджеру проекта.

В качестве query-параметров укажите:

curl -X 'GET' \
'https://subscriptions.xsolla.com​/api/user/v1/projects/{project_id}/products/{​​productId}/plans?country=RU  ' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer client_user_jwt'

{
  "items": [
    {
      "plan_id": 54321,
      "plan_external_id": "PlanExternalId",
      "plan_group_id": "TestGroupId",
      "plan_type": "all",
      "plan_name": "Localized plan name",
      "plan_description": "Localized plan description",
      "plan_start_date": "2021-04-11T13:51:02+03:00",
      "plan_end_date": "2031-04-11T13:51:02+03:00",
      "trial_period": 7,
      "period": {
        "value": 1,
        "unit": "month"
      },
      "charge": {
        "amount": 4.99,
        "setup_fee": 0.99,
        "currency": "USD"
      },
      "promotion": {
        "promotion_charge_amount": 3.99,
        "promotion_remaining_charges": 3
      }
    }
  ],
  "has_more": false
}

Клиентский метод получения списка планов

В клиентской части вашего приложения реализуйте получение списка планов по продукту с использованием HTTP GET-запроса https://subscriptions.xsolla.com​/api/user/v1/projects/{project_id}/plans.

Запрос к методу должен содержать заголовок Authorization: Bearer <client_user_jwt>, где <client_user_jwt> — JSON Web Token (JWT) пользователя — уникальный токен, закодированный по стандарту Base64. Используйте для его получения:

• Методы API Register new user и Auth by username, если в вашем приложении используется авторизация по логину и паролю.
• Метод API Auth via social network, если в вашем приложении используется авторизация через социальные сети.

В качестве path-параметра укажите projectId — ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

В качестве query-параметров укажите:

curl -X 'GET' \
'https://subscriptions.xsolla.com​/api/user/v1/projects/{project_id}/plans?country=RU  ' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer client_user_jwt'
  

{
  "items": [
    {
      "plan_id": 54321,
      "plan_external_id": "PlanExternalId",
      "plan_group_id": "TestGroupId",
      "plan_type": "all",
      "plan_name": "Localized plan name",
      "plan_description": "Localized plan description",
      "plan_start_date": "2021-04-11T13:51:02+03:00",
      "plan_end_date": "2031-04-11T13:51:02+03:00",
      "trial_period": 7,
      "period": {
        "value": 1,
        "unit": "month"
      },
      "charge": {
        "amount": 4.99,
        "setup_fee": 0.99,
        "currency": "USD"
      },
      "promotion": {
        "promotion_charge_amount": 3.99,
        "promotion_remaining_charges": 3
      }
    }
  ],
  "has_more": false
}

В платежном интерфейсе Иксолла

Способ создания каталога в платежном интерфейсе зависит от настроек авторизации в вашем проекте:

• используется собственная система авторизации;
• настроена Авторизация Иксолла.

Собственная система авторизации

Если в вашем приложении используется собственная система авторизации:

1. Реализуйте получение токена с помощью серверного метода Создание токена. В запросе к методу передайте информацию о пользователе в параметрах user.id и user.email.
2. Реализуйте открытие платежного интерфейса в Pay Station Embed, iframe или в новом окне.

{
    "user": {
        "id": {
            "value": "1234567",
            "hidden": true
        }
    },
    "settings": {
        "project_id": 123456,
        "language": "en",
        "currency": "USD"
    }
}

Авторизация Иксолла

Если в вашем проекте настроена Авторизация Иксолла:

В клиентской части вашего приложения реализуйте получение ссылки на открытие платежного интерфейса с использованием HTTP POST-запроса https://subscriptions.xsolla.com​/api/user/v1/projects/{project_id}/subscriptions/buy.

Запрос к методу должен содержать заголовок Authorization: Bearer <client_user_jwt>, где <client_user_jwt> — JSON Web Token (JWT) пользователя — уникальный токен, закодированный по стандарту Base64. Используйте для его получения:

• Методы API Register new user и Auth by username, если в вашем приложении используется авторизация по логину и паролю.
• Метод API Auth via social network, если в вашем приложении используется авторизация через социальные сети.

В качестве path-параметра укажите projectId — ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

В качестве query-параметра укажите country — страна пользователя в двухбуквенном обозначении согласно стандарту ISO 3166-1 alpha-2. Влияет на выбор локали и валюты. Если параметр не передается, страна определяется по IP-адресу пользователя.

Параметры тела запроса:

При необходимости передайте дополнительные параметры для кастомизации платежного интерфейса.

curl -X 'POST' \
'https://subscriptions.xsolla.com​/api/user/v1/projects/{project_id}/subscriptions/buy?country=RU  ' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer client_user_jwt'

{
  "plan_external_id": "PlanExternalId",
  "settings": {
    "ui": {
      "size": "large",
      "theme": "string",
      "version": "desktop",
      "desktop": {
        "header": {
          "is_visible": true,
          "visible_logo": true,
          "visible_name": true,
          "type": "compact",
          "close_button": true
        }
      },
      "mobile": {
        "mode": "saved_accounts",
        "footer": {
          "is_visible": true
        },
        "header": {
          "close_button": true
        }
      },
      "license_url": "string",
      "mode": "user_account",
      "user_account": {
        "history": {
          "enable": true,
          "order": 1
        },
        "payment_accounts": {
          "enable": true,
          "order": 1
        },
        "info": {
          "enable": true,
          "order": 1
        },
        "subscriptions": {
          "enable": true,
          "order": 1
        }
      }
    },
    "currency": "string",
    "locale": "string",
    "external_id": "string",
    "payment_method": 1,
    "return_url": "string",
    "redirect_policy": {
      "redirect_conditions": "none",
      "delay": 0,
      "status_for_manual_redirection": "none",
      "redirect_button_caption": "string"
    }
  }
}

{
  "link_to_ps": "https://secure.xsolla.com/paystation2/?access_token=<access_token>"
}

Пример отображения каталога подписок в платежном интерфейсе Иксолла:

В Конструкторе сайтов Иксолла

В Конструкторе сайтов вы можете создать и настроить свой сайт для продажи подписок. Для этого создайте сайт с помощью шаблона Веб-магазин. Подробнее о настройке вы можете прочитать в инструкции Веб-магазин с аутентификацией пользователя.