ОБЩАЯ ИНФОРМАЦИЯ
Принцип работы
- Программный интерфейс построен на принципах REST, на основе спецификации JSON-API.
- При отправке запросов необходимо отправлять HTTP заголовок Content-Type=application/json.
- Базовый адрес продуктивного окружения https://api.x10pay.com
- Тайм-аут на получение ответа от API — 1 минута.
Аутентификация
Для доступа к API используется Bearer аутентификация на основе JWT токена. JWT токен (access token) необходимо передавать в каждом требующем аутентификации запросе в HTTP заголовке Authorization.
Access token можно получить в личном кабинете мерчанта:
- Получите приглашение от вашего личного менеджера по Email
- Перейдите по ссылке из письма, чтобы задать пароль
- После создания пароля авторизуйтесь в личном кабинете мерчанта https://merchant.x10pay.com
- В разделе "Терминалы" нажмите на плитку с боковым терминалом
- Справа откроется панель с настройками, в ней нужно создать токены. Всего можно создать от 1 до 5 токенов.
- Придумайте название и выберите время жизни токена. Время жизни access token составляет от 1 до 12 месяцев.
- После истечения этого времени запросы к API начнут возвращать 401 HTTP статус код.
На стороне системы WATA не хранится access token, поэтому его невозможно восстановить. Возможно только сгенерировать access token заново, поэтому после генерации токена рекомендуем хранить его в безопасном месте.
HTTP статус коды ответов
В случае ошибки при обработке запроса API возвращает HTTP статус код, отличный от 200-го.
| Код | Описание | Комментарий |
|---|---|---|
| 401 | Запрос не авторизован | Не передан access token или передан access token с истекшим сроком действия, обновите access token |
| 403 | Доступ запрещен | У вас нет доступа к запрашиваемой эндпоинт |
| 400 | Некорректный запрос | Данные в запросе некорректны. Проверьте запрос, исправьте данные и повторите попытку |
| 500 | Ошибка сервера | Обратитесь пожалуйста в техподдержку с описанием проблемы и указанием тела запроса |
Также в случае получения 400-го кода возвращается ответ с детализацией ошибки.
Пример ответа с детализацией ошибки (Response 400):
{
"error": {
"code": null,
"message": "Ваш запрос недействителен",
"details": "При проверке были обнаружены следующие ошибки - 'Amount' должно быть заполнено.",
"data": {
}
},
"validationErrors": {
"message": "'Amount' должно быть заполнено.",
"members": [
"amount"
]
}
}
ПОПОЛНЕНИЕ АККАУНТОВ В STEAM
Получение стоимости пополнения аккаунта
Этот метод позволяет получить текущую стоимость пополнения Steam аккаунта в рублях. Метод учитывает актуальный курс конвертации и комиссии системы.
Endpoint: GET /api/v1/steam/account/cost
Параметры запроса:
- amount (number, required) - сумма пополнения в валюте Steam
- currency (string, required) - валюта пополнения (USD, EUR, RUB)
Создание заказа
Создание заказа на пополнение Steam аккаунта. После успешного создания заказа, средства будут зачислены на указанный Steam аккаунт.
Endpoint: POST /api/v1/steam/orders
Тело запроса:
{
"steam_id": "76561198000000000",
"amount": 1000,
"currency": "RUB",
"callback_url": "https://yoursite.com/callback"
}
ПОКУПКА ИГРОВЫХ ПОЗИЦИЙ (TOPUP)
Получение списка игр и позиций
Метод возвращает список доступных игр и внутриигровых позиций для покупки. Список включает популярные игры, такие как PUBG Mobile, Mobile Legends, Free Fire и другие.
Endpoint: GET /api/v1/topup/games
Параметры запроса:
- region (string, optional) - регион для фильтрации игр
- platform (string, optional) - платформа (mobile, pc, console)
Создание заказа
Создание заказа на покупку внутриигровой валюты или предметов. Поддерживается широкий спектр популярных игр.
Endpoint: POST /api/v1/topup/orders
Тело запроса:
{
"game_id": "pubg_mobile",
"product_id": "uc_660",
"player_id": "5123456789",
"server_id": "asia",
"amount": 1
}
ПОКУПКА ВАУЧЕРОВ (VOUCHERS)
Получение списка сервисов
Метод возвращает список доступных сервисов для покупки ваучеров. Включает в себя подписки на стриминговые сервисы, игровые платформы, маркетплейсы и другие цифровые услуги.
Endpoint: GET /api/v1/vouchers/services
Параметры запроса:
- category (string, optional) - категория сервисов (streaming, gaming, marketplace)
- region (string, optional) - регион доступности
Создание заказа
Создание заказа на покупку ваучера. После успешной покупки вы получите код активации, который можно использовать на соответствующей платформе.
Endpoint: POST /api/v1/vouchers/orders
Тело запроса:
{
"service_id": "steam_wallet",
"voucher_type": "gift_card_50",
"quantity": 1,
"email": "customer@example.com"
}