Разделы документации

Начало

Быстрый старт Ключи и заголовки Базы и поля

Методы

GET /v1/me GET /v1/{base}/makes GET /v1/{base}/models GET /v1/{base}/filters GET /v1/{base}/lots GET /v1/{base}/lots/{id} GET /v1/rates

Правила

Ошибки Лимиты Капча посетителя Фото и Referer

Инструменты

Песочница SDK для PHP Примеры

Ошибки

При ошибке ok: false, HTTP-код соответствует ошибке, а в error.code — машинный код. error.message — пояснение по-русски, его можно писать в журнал, но не стоит показывать посетителю как есть.

{ "ok": false, "error": { "code": "ip_not_allowed", "message": "IP 198.51.100.4 не входит в список адресов сервера сайта" } }
HTTPcodeКогдаЧто делать
400bad_requestневерный параметр, нет X-Visitor-Ipисправить запрос; лимит не тратится
401unauthorizedнет ключа, ключ неверный, отозван или заблокированпроверить ключ в кабинете
402no_subscriptionнет активной подписки на базуоплатить или продлить подписку
403ip_not_allowedзапрос не с IP сервера сайтауказать IP в настройках сайта
404not_foundнет такого метода, базы или лоталот мог уйти с торгов — убрать со страницы
428captcha_requiredпосетитель превысил лимит запросовпоказать посетителю капчу
429limit_exceededисчерпан суточный лимит ключа или лимит посетителя после капчиподождать: см. заголовок Retry-After
429coverage_exceededза сутки запрошено слишком много разных карточекдо полуночи МСК новые карточки не открываются
500internalсбой на нашей стороне или база обновляетсяповторить через минуту, показать кэш

Ответ 428 дополнительно содержит error.captcha с адресами виджета и методов капчи.

Рекомендации

  • Таймаут запроса — 10 секунд. При сетевой ошибке или 500 показывайте посетителю сохранённую копию страницы.
  • Не повторяйте запрос сразу при 429 — это тоже расходует лимит посетителя.
  • Пишите error.code в журнал — по нему проще найти причину.