API-ключи и аутентификация
Создание API-ключа, ограничение по IP, передача ключа и основные коды ошибок.
API нужен, чтобы автоматически оформлять заказы из вашего магазина или бота. Полная документация — в разделе Документация API панели и на https://partner.goxost.net/docs.
Создание ключа
- Откройте в панели раздел API-ключи.
- Дайте ключу название (например, имя сервера или проекта).
- При желании укажите в поле Разрешённые IP адреса ваших серверов — один IP или CIDR на строку (например,
203.0.113.10или203.0.113.0/24). Пустое поле — любой IP. - Нажмите Создать ключ.
- Полный ключ (
gxp_…) показывается только один раз. Скопируйте его и надёжно сохраните в настройках сервера.
У нас хранится только хеш ключа — потерянный ключ восстановить нельзя, создайте новый.
Важные правила
- Одновременно может быть не более 10 активных ключей.
- Ключ можно создать сразу, но API заработает после одобрения аккаунта.
- Храните ключ только на сервере — не размещайте его в браузере, мобильном приложении или публичном репозитории.
- Если ключ утёк, нажмите Отозвать — запросы с ним сразу перестанут работать. Затем создайте новый.
- Для каждого рабочего ключа рекомендуем включить список IP.
Передача ключа
Базовый адрес: https://partner.goxost.net/api/v1. Все запросы — только по HTTPS. Передавайте ключ в одном из заголовков:
Authorization: Bearer gxp_XXXXXXXX
X-Api-Key: gxp_XXXXXXXX
Проверка подключения:
curl https://partner.goxost.net/api/v1/balance \
-H "Authorization: Bearer $PARTNER_API_KEY"
Основные запросы
| Запрос | Назначение |
|---|---|
GET /balance |
Баланс и текущий тариф |
GET /offers |
Каталог предложений |
GET /offers/{id} |
Одно предложение |
POST /offers/{id}/check |
Предварительная проверка игрока |
POST /orders |
Оформить заказ |
GET /orders/{transaction_id} |
Статус заказа |
GET /orders |
Список заказов |
transaction_id — ваш уникальный номер заказа. Если после сетевой ошибки повторить тот же запрос с тем же transaction_id, деньги дважды не спишутся.
Ошибки аутентификации
| Код | HTTP | Причина |
|---|---|---|
UNAUTHENTICATED |
401 | Ключ не передан или неверен |
IP_NOT_ALLOWED |
403 | Запрос пришёл с адреса, которого нет в списке IP ключа |
ACCOUNT_NOT_ACTIVE |
403 | Аккаунт ещё не одобрен или приостановлен |
RATE_LIMITED |
429 | Слишком много запросов — подождите Retry-After секунд |
В каждом ответе есть заголовки X-RateLimit-Limit и X-RateLimit-Remaining. Лимит общий для всех ключей аккаунта. Полный список кодов ошибок — в главе «Ошибки и лимиты» документации API.