Ошибки

Когда API-запрос завершается неудачей, badges.ninja возвращает JSON с описанием ошибки и соответствующим HTTP-статусом.

Формат ошибки

Все ошибки имеют такую структуру:

{
  "error": "description of what went wrong"
}

Коды статусов

Код	Значение	Когда возникает
400	Bad Request	Отсутствующие или неверные параметры
402	Payment Required	Достигнута месячная квота наград или функция требует более высокого тарифа
403	Forbidden	Достигнут лимит тарифа (например, по эмитентам или значкам)
404	Not Found	Запрошенный ресурс не существует
429	Too Many Requests	Превышен лимит частоты
500	Internal Server Error	Непредвиденная ошибка на сервере

Типичные ошибки и решения

Отсутствуют обязательные параметры

{ "error": "missing required parameters: name, url, email" }

Решение: Включите все обязательные параметры в тело запроса. Проверьте документацию эндпоинта.

Неверный e-mail

{ "error": "invalid email" }

Решение: Передайте корректный адрес в формате user@domain.com.

Неверный URL

{ "error": "invalid URL" }

Решение: Передайте полный URL с протоколом, например https://example.com.

Слишком короткое имя

{ "error": "name must be at least 3 characters" }

Решение: Используйте более длинное имя. Для имени эмитента нужно минимум 3 символа. Для имени получателя — 5 символов.

Эмитент не подтверждён

{ "error": "issuer must be verified before creating badges" }

Решение: Сначала подтвердите эмитента. Проверьте почту эмитента на ссылку подтверждения или используйте эндпоинт Verify Issuer.

Достигнута месячная квота наград

{ "error": "monthly award quota reached" }

Решение: Вы использовали все награды по тарифу за текущий период (Free: 100/мес, Starter: 1 000/мес, Pro: 10 000/мес). Подождите следующего сброса или повысьте тариф. См. Тарифы и оплата.

Достигнут лимит тарифа

{ "error": "issuer limit reached for your plan" }

Решение: Вы исчерпали лимит тарифа на эмитентов, значки или ключи API. Удалите неиспользуемый ресурс или повысьте тариф.

Блокчейн требует Pro

{ "error": "blockchain verification requires the Pro plan" }

Решение: Параметр blockchain доступен только на тарифе Pro. Перейдите на него для включения on-chain-верификации.

Неподдерживаемый блокчейн

{ "error": "unsupported blockchain, only 'matchain' is supported" }

Решение: Сейчас в качестве значения параметра поддерживается только matchain.

У ресурса есть зависимости

{ "error": "issuer has badges and cannot be deleted" }

Решение: Удалите все значки под эмитентом, прежде чем удалять эмитента. Аналогично, удалите все награды под значком, прежде чем удалять значок.

Не авторизован

{ "error": "not authorized" }

Решение: Можно изменять только свои ресурсы. Убедитесь, что используете правильный ключ API.

HTML в тексте шаринга

{ "error": "HTML tags are not allowed" }

Решение: Текст шаринга должен быть простым текстом. Удалите HTML-теги из параметра text.