С чего начать
Аутентификация
Каждый вызов содержит ваш ключ API в теле запроса. Ключ определяет аккаунт, применяет его ограничение частоты и ограничивает каждое действие данными этого аккаунта.
Куда помещать ключ
Передавайте ключ в поле key в теле запроса с form-encoded кодировкой. Аутентификация через заголовки не поддерживается — спецификация v2 использует параметры тела для совместимости с существующими реселлерскими SDK.
Content-Type: application/x-www-form-urlencoded
key=YOUR_API_KEY&action=servicesКак отправить запрос
Отправьте POST с полями формы (application/x-www-form-urlencoded) или JSON-объектом с теми же плоскими именами. Размер тела — не более 32 КБ. Неизвестные параметры игнорируются, а пустое значение считается отсутствующим. Любой другой метод отклоняется с METHOD_NOT_ALLOWED.
Что проверяется при каждом запросе
Ключ, аккаунт и переключатель API проверяются заново при каждом вызове, поэтому приостановленный аккаунт или отозванный ключ перестаёт работать сразу. Аккаунт должен быть активным, а его адрес электронной почты — подтверждённым.
- 401
INVALID_KEY
Invalid API keyКлюч отсутствует, неверен или отозван. Сначала исправьте запрос.
- 403
INACTIVE_ACCOUNT
Account suspendedАккаунт приостановлен. Сначала исправьте запрос.
- 403
EMAIL_UNVERIFIED
Email verification requiredАдрес электронной почты аккаунта ещё не подтверждён. Сначала исправьте запрос.
- 503
API_DISABLED
The API is temporarily disabledAPI отключён на короткое время. Retry-After указывает, когда повторить. Повтор может помочь.
- 405
METHOD_NOT_ALLOWED
Use POSTЗапрос не был POST. Сначала исправьте запрос.
- 413
BODY_TOO_LARGE
Request body too largeТело запроса слишком большое. Сначала исправьте запрос.
key=YOUR_API_KEY&action=balance{
"error": "Invalid API key",
"error_code": "INVALID_KEY",
"retryable": false
}Создание и замена ключей
Ключи создаются и отзываются в /dashboard/api. Исходный ключ показывается ровно один раз. Сервер хранит односторонний верификатор и короткий несекретный идентификатор, поэтому исходное значение позднее восстановить нельзя.
Максимум 5 активных ключей
на учётную запись. Старые ключи можно отзывать по отдельности.Замена без простоя.
Создайте новый ключ, обновите интеграцию, затем отзовите старый. Новые запросы с отозванным ключом отклоняются.Нужна активная сессия панели.
Для создания требуется аутентифицированная сессия панели без режима имперсонации. Дополнительный код из письма или пароль не запрашивается.
Чего не может API-ключ
Ключ API v3 ограничен документированными действиями и не дает доступа к сеансу панели управления или данным других учетных записей.
- Выводить или переводить баланс.
- Изменять email, пароль или настройки 2FA учётной записи.
- Создавать или отзывать другие ключи API через API.
- Обращаться к административным или модераторским эндпоинтам.
Храните ключ в безопасности
- Только на стороне сервера. Никогда не встраивайте API-ключ в браузерный бандл, мобильное приложение или любой клиент, который другая сторона может декомпилировать.
- Используйте переменные окружения. Не коммитьте ключи в git. Файлы
.envдолжны быть в.gitignore. - Отзывайте при подозрении. Если ключ попал в журнал, снимок экрана или общий чат, создайте замену и отзовите раскрытый ключ.
- Используйте webhook, чтобы сократить опросы, когда это полезно. Доставка выполняется по возможности с повторными попытками; обработчики должны быть идемпотентными, а важное состояние следует сверять через
action=status.