Как получить платежный токен
Для открытия платежного интерфейса необходимо получить токен. Токен — это строка, в которой содержится зашифрованная информация об игре и пользователе. Вам необходимо реализовать получение токена, чтобы идентифицировать пользователя для начисления покупки.
Чтобы получить платежный токен:
Получение авторизационного токена пользователя
Время жизни токена — 24 часов с момента последнего обращения к Xsolla API. Реализуйте получение нового токена после истечения срока действия. Рекомендуется получать новый токен в фоновом режиме, без необходимости повторного входа пользователя в приложение.
В серверной части вашего приложения реализуйте получение авторизационного токена. Для этого используйте HTTP POST-запрос с базовой HTTP-аутентифтикацией и передайте в теле запроса обязательные параметры.
Базовая HTTP-аутентификация
Xsolla API использует базовую HTTP-аутентификацию. Все запросы к API должны содержать заголовок Authorization: Basic <your_authorization_basic_key>, где <your_authorization_basic_key> — пара ID продавца:ключ API, закодированная по стандарту Base64. Значения параметров вы можете найти в Личном кабинете:
- ID продавца указан:
- В разделе Настройки компании > Компания.
- Aдресной строке браузера на любой странице Личного кабинета. URL-адрес имеет вид
https://publisher.xsolla.com/<merchant ID>/<Publisher Account section>.
- Ключ API отображается в Личном кабинете только при создании и должен храниться на вашей стороне. Создать ключ можно в разделах:
- Настройки компании > Ключи API;
- Настройки проекта > Ключи API.
Подробная информация о работе с ключами API приведена в справочнике API.
Основные рекомендации:
- Сохраните созданный ключ API на вашей стороне. Вы можете посмотреть ключ API в Личном кабинете только один раз при его создании.
- Никому не сообщайте ваш ключ API, так как он дает доступ к управлению аккаунтом и проектами в Личном кабинете.
- Ключ API должен храниться на вашем сервере и никогда — в бинарных файлах или на фронтенде.
Если необходимый метод API не включает в себя path-параметр project_id, используйте для авторизации ключ API, который действует во всех проектах.
Тело запроса
В теле запроса передайте обязательные параметры:
| Параметр | Тип | Описание |
|---|---|---|
user.id | string | Уникальный ID пользователя в вашей системе. |
user.email | string | Email-адрес пользователя для отправки чеков. Если параметр не передан в запросе, на платежной форме появляется обязательное поле для ввода email-адреса. |
settings.project_id | integer | ID игры в Xsolla. Вы можете найти эту информацию в Личном кабинете в разделе проекта. |
Для улучшения пользовательского опыта, вы также можете передать следующие параметры:
| Параметр | Тип | Описание |
|---|---|---|
user.name | string | Никнейм пользователя, который отображается в чеке. |
settings.currency | string | Предпочтительная валюта платежа. |
settings.language | string | Язык платежного интерфейса. |
curl -i -X POST \
-u 2340:ZHgbSDVP6LtAJVWu \
https://api.xsolla.com/merchant/v2/merchants/<merchant_id>/token \
-H 'Content-Type: application/json' \
-d '{
"settings": {
"currency": "USD",
"language": "en",
"project_id": <project_id>
}
},
"user": {
"email": {
"value": "<user_email>"
},
"id": {
"value": "<user_id>"
},
"name": {
"value": "<user_name>"
}
}
}'
Пример авторизационного токена пользователя, который приходит в ответе
{
"token": "1230OWrp0KF6uqvmN8jWuzLyoXMzxTyK_lc_en"
}
Получение платежного токена
Чтобы получить платежный токен, создайте заказ. Заказ — это товар, который пользователь выбрал для покупки в магазине. После того как заказ оплачен, пользователь получает товар. Для тестирования оплаты создайте заказ, используя метод API Создание заказа с указанным товаром:
- Если вы тестируете на сайте документации API, нажмите
Try it для открытия интерфейса создания запроса. - В блоке
Security в полеBearer Token введите токен, полученный при прохождении аутентификации. - В блоке
Body передайте информацию о заказе, например количество товара. Чтобы получить доступ к тестовому окружению, передайте"sandbox": true. - В блоке
Parameters введите:project_id— ID проекта, который вы можете найти в Личном кабинете.item_sku— артикул товара.
В ответе вы получите данные, которые вам понадобятся для дальнейшей работы:
token— платежный токен.
Нашли опечатку или ошибку в тексте? Выделите ее и нажмите Ctrl+Enter.
