Часто задаваемые вопросы по SE Ranking API

Q Я получаю ошибку 402 "Insufficient Funds", хотя в панели отображаются доступные кредиты. В чём проблема?

A Эта ошибка возвращается с сообщением Insufficient funds, API key is temporarily disabled. Это самая распространённая проблема у новых пользователей. Обычно это означает, что API-ключ ещё не полностью связан с кредитами. Такое может происходить сразу после покупки или смены плана. Подождите несколько минут и попробуйте снова. Если ошибка сохраняется более 10 минут, свяжитесь с нами, и команда поддержки поможет решить проблему.

Q Я получаю ошибку 401 Unauthenticated. Что это значит?

A Ошибка 401 означает сбой аутентификации, а не проблему с кредитами. В запросе не было действительного API-ключа, поэтому баланс аккаунта здесь не важен: 401 может возникать даже при полностью пополненном API Wallet.

Что проверить:

• ключ передаётся в запросе точно так, как он показан в API Dashboard, без обрезки и лишних пробелов;
• ключ ещё существует: удалённый или перевыпущенный ключ сразу перестаёт работать;
• вы используете тип ключа, который ожидает эндпоинт (см. Можно ли использовать один API-ключ для Data- и Project-эндпоинтов?).

Если ключ верный и актуальный, но 401 сохраняется, свяжитесь с нами и укажите название ключа и время неудачного запроса.

Q Я получаю ошибку 403, хотя в API Wallet отображаются доступные кредиты. Что это значит?

A Ошибка 403 означает, что у аккаунта сейчас нет доступа к Data API. Это не связано с тем, сколько средств на балансе Wallet. Право на использование Data API даёт активная подписка или дополнение, а сам баланс Wallet при этой проверке не учитывается. Поэтому кредиты на аккаунте могут быть, а доступ всё равно не предоставят.

Что проверить:

• активен ли тариф или дополнение, которое даёт доступ к Data API, не истёк ли его срок и не был ли он понижен;
• не отправляете ли вы запросы из субаккаунта или клиентского аккаунта агентства вместо основного аккаунта, у которого есть доступ;
• API Dashboard: доступ к Data API и баланс Wallet отображаются там как две отдельные величины.

Если дополнение выглядит активным, но 403 сохраняется, свяжитесь с нами, и мы проверим права доступа на аккаунте.

Q Можно ли использовать один API-ключ для Data- и Project-эндпоинтов?

A Да. Один API-ключ используется для авторизации запросов как к Data-, так и к Project-эндпоинтам. Оба типа эндпоинтов доступны через api.seranking.com и Data API gateway, поэтому отдельный ключ для Project API не требуется.

Q Во время тестирования я достиг лимита запросов. Где посмотреть ограничения моего плана?

A Лимиты зависят от тарифа и могут быстро достигаться при массовом тестировании. Ограничения для вашего плана указаны в документации. Рекомендуем проверить их перед запуском большого количества запросов, чтобы распределить их частоту.

Q Как узнать, сколько кредитов расходует каждый API-запрос?

A Стоимость зависит от конкретного эндпоинта. Перед запуском крупных задач проверьте стоимость в документации, чтобы оценить расход кредитов. Текущий баланс всегда доступен в API Dashboard.

Q «Ваш план не включает кредиты API. Обновите план или пополните баланс, чтобы начать.» Что это значит?

A Это значит, что в вашем текущем тарифе или балансе пока нет кредитов Data API. Чтобы начать делать запросы, перейдите на тариф с кредитами Data API или пополните баланс аккаунта, а затем создайте или сохраните API-ключ. Если вы считаете, что кредиты уже должны быть доступны, свяжитесь с нами.

Q Как отслеживать использование кредитов API и видеть стоимость каждого запроса?

A Текущий баланс кредитов всегда доступен в API Dashboard, а стоимость по каждому эндпоинту указана в документации, чтобы вы могли оценить расход перед запуском крупных задач.

Q Я пополнил баланс, но Data API всё равно показывает "No API access". Почему?

A Баланс аккаунта SE Ranking оплачивает инструменты SE Ranking с оплатой по мере использования (например, Кластеризацию и Определение частотности). Он не восстанавливает доступ к Data API для аккаунта, у которого истёк пробный период. Для Data API требуется активный платный тариф с кредитами API или отдельные кредиты API с оплатой по мере использования. Если ваш пробный период закончился, пополнение баланса само по себе не восстановит доступ к Data API. Перейдите на тариф с кредитами Data API или приобретите отдельные кредиты API с оплатой по мере использования. Если вы считаете, что доступ к API уже должен быть активен, свяжитесь с нами.

Q Как работают кредиты API Wallet (с оплатой по мере использования) и в каком порядке расходуются мои кредиты?

A API Wallet содержит отдельные кредиты Data API с оплатой по мере использования и не связан с общим балансом аккаунта SE Ranking (который оплачивает инструменты с оплатой по мере использования, например Кластеризацию и Определение частотности). В отличие от общего баланса, кредиты API Wallet действительно дают доступ к Data API. Первое пополнение API Wallet может активировать Data API, даже если ваш план или пробный период истёк.

Где найти: баланс API Wallet отображается на главной карточке API Dashboard и в отдельном разделе «Wallet», где можно пополнить баланс, настроить автопополнение, включить уведомления о низком балансе и просмотреть историю транзакций. Автопополнение и уведомления о низком балансе отмечены в разделе «Wallet» как «Coming soon» и пока недоступны для настройки.

Порядок расходования кредитов: сначала расходуются кредиты API, включённые в ваш план и дополнительные пакеты, и только после того как они закончатся, начинает использоваться баланс API Wallet.

Только что пополнили, но доступа ещё нет? После покупки кредиты применяются асинхронно и баланс обновляется с небольшой задержкой, поэтому доступ может появиться не сразу. Подождите немного и обновите API Dashboard. Если купленный баланс всё ещё не отображается, свяжитесь с нами.

Q Истекает ли срок действия кредитов API Wallet и сбрасываются ли они каждый месяц?

A Нет. Кредиты API Wallet покупаются как разовое пополнение с оплатой по мере использования. Срок их действия не истекает, и они не сбрасываются в начале расчётного периода: неиспользованный баланс Wallet сохраняется, пока вы его не потратите.

С кредитами API, включёнными в тариф или дополнительный пакет, всё наоборот: они обновляются с началом расчётного цикла и не переносятся. Поскольку кредиты тарифа и дополнительных пакетов расходуются первыми, баланс Wallet обычно начинает использоваться только после того, как обновляемый объём за период исчерпан.

Q Какие тарифы и типы аккаунтов могут пополнять API Wallet?

A Ограничений на уровне тарифа для покупки кредитов API Wallet нет. Пополнить API Wallet могут аккаунты Core и Growth, а также аккаунты на других платных тарифах. Проверяется сам аккаунт, а не название тарифа.

Пополнение недоступно, если:

• вы вошли в субаккаунт: покупку нужно совершать из основного аккаунта;
• это клиентский аккаунт, созданный в рабочем пространстве агентства;
• к аккаунту не привязана подписка;
• кредиты некуда зачислить, например при активном тарифе, в котором вообще нет квоты Data API.

Если вы ожидаете, что пополнение должно быть доступно, но эта опция отсутствует, свяжитесь с нами, и мы проверим аккаунт.

Q Почему кредиты API Wallet не отображаются в ответе /account/subscription?

A Так и должно быть. Эндпоинт /account/subscription возвращает только состояние подписки: баланс, тип и признак истечения срока. Кредиты API Wallet в него не входят, поэтому пополнение Wallet не изменит ответ этого эндпоинта. Баланс API Wallet смотрите в API Dashboard. Если вы купили кредиты Wallet и там они тоже не отображаются, свяжитесь с нами.

Q Можно ли удалить, перевыпустить или ограничить API-ключ?

A Ключами можно управлять в API Dashboard, в таблице API-ключей.

• Удаление: ключ Data API можно удалить в таблице ключей. Последний оставшийся ключ Data API удалить нельзя. Сначала создайте новый ключ, а затем удалите старый.
• Перевыпуск: ключ Project API можно перевыпустить. При этом создаётся новое значение, а старое перестаёт работать. Сразу после перевыпуска обновите все интеграции, которые его используют.
• Ограничение: сейчас область действия API-ключей ограничить нельзя. Нет настроек для белых списков IP, ограничений по эндпоинтам или прав доступа для отдельного ключа. При создании ключа задаются только тип и название. Если ключ мог попасть в чужие руки, удалите или перевыпустите его, а не пытайтесь ограничить его действие.

Если ключ нужно срочно отозвать, свяжитесь с нами.