Личный кабинет подписчика

Как это работает

Личный кабинет подписчика — сервис, с помощью которого пользователи могут получать информацию о своих подписках, настроенных в вашем проекте Xsolla, и управлять ими.

• просмотр информации о подписке;
• управление подпиской — немедленная отмена, отключение автоматического продления или повторная активация (в зависимости от настроек проекта, заданных вами);
• изменение плана подписки;
• замена способа оплаты.

• перейдя по ссылке, полученной в email-уведомлениях о подписках от Xsolla;
• со страницы оплаты в игре.

• c помощью серверного метода API;
• c помощью клиентского метода API.

Получение ссылки на открытие личного кабинета подписчика с помощью API

Серверный метод

Метод позволяет реализовать получение ссылки на личный кабинета подписчика в серверной части вашего приложения с использованием HTTP POST-запроса.

URL-адрес:

https://subscriptions.xsolla.com​/api/user/v1/projects/{project_id}/subscriptions/user_account

Авторизация:

Запрос использует базовую HTTP-аутентификацию. Все запросы к API должны содержать заголовок Authorization: Basic <your_authorization_basic_key>, где <your_authorization_basic_key> — пара merchant_id:api_key, закодированная по стандарту Base64. Значения параметров вы можете найти в Личном кабинете:

• merchant_id указан:
  • В разделе Настройки компании > Компания.
  • Адресной строке браузера на любой странице Личного кабинета. URL-адрес имеет вид: https://publisher.xsolla.com/<merchant_id>.
• api_key отображается в Личном кабинете только при создании и должен храниться на вашей стороне. Создать ключ можно в разделах:
  • Настройки компании > Ключи API;
  • Настройки проекта > Ключи API.

Параметры:

В качестве path-параметра укажите project_id — ID проекта в Личном кабинете, который указан рядом с названием вашего проекта или в адресной строке браузера. URL-адрес имеет вид https://publisher.xsolla.com/<merchantId>/projects/<projectId>.

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

 1curl -v https://subscriptions.xsolla.com​/api/v1/projects/{projectId}/subscriptions/user_account \
 2-X POST \
 3-u your_merchant_id:merchant_api_key \
 4-H 'Content-Type:application/json' \
 5-H 'Accept: application/json' \
 6-d '
 7{
 8  "user_v1": "user123",
 9  "locale": "en"
10}'

Пример ответа:

1{
2  "redirect_url": "https://subscriptions-user-account.xsolla.com/?token=<access_token>&projectId=<project_id>&merchantId=<merchant_id>&locale=<locale>"
3}

Клиентский метод

Метод позволяет реализовать получение ссылки на личный кабинета подписчика в серверной части вашего приложения с использованием HTTP GET-запроса, если в проекте настроен Xsolla Login.

URL-адрес:

https://subscriptions.xsolla.com​/api/user/v1/projects/{project_id}/subscriptions/user_account

Авторизация:

Запрос к методу должен содержать заголовок 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-параметра укажите project_id — ID проекта в Личном кабинете, который указан рядом с названием вашего проекта или в адресной строке браузера. URL-адрес имеет вид https://publisher.xsolla.com/{merchantId}/projects/{projectId}.

В качестве query-параметра укажите locale — язык интерфейса в двухбуквенном обозначении согласно стандарту ISO 639-1. Если параметр не передается, язык определяется по IP-адресу пользователя. Если переданная локаль отсутствует в списке Xsolla, английский язык используется по умолчанию.

Пример запроса:

1curl -v https://subscriptions.xsolla.com​/api/user/v1/projects/{project_id}/subscriptions/user_account \
2-X GET \
3-u your_merchant_id:merchant_api_key \
4-H 'Content-Type:application/json' \
5-H 'Accept: application/json' \

Пример ответа:

1{
2  "redirect_url": "https://subscriptions-user-account.xsolla.com/?token=<access_token>&projectId=<project_id>&merchantId=<merchant_id>&locale=<locale>"
3}