Документация
Всё, что нужно, чтобы поставить каталог и не звонить в поддержку: параметры виджета, методы API, коды ошибок и разбор типичных сбоев.
Параметры вставки
<div id="parts-catalog" data-key="ВАШ_КЛЮЧ" data-language="ru" data-theme="red" data-back-url="/cart"></div> <script src="https://gui.goodvin.net/v3/catalog.js"></script>| Атрибут | Значения | Что делает |
|---|---|---|
| id | parts-catalog | Обязателен. Скрипт ищет контейнер строго по этому идентификатору, поэтому на странице возможен один каталог |
| data-key | строка | Обязателен. Ключ привязан к домену |
| data-language | ru, en, de, tr, es, fr, uk, lv, et | Язык интерфейса каталога |
| data-theme | red, blue, yellow | Цветовая схема |
| data-back-url | путь | Куда ведёт клик по детали. Подставляются {brand} и {article} — например ВАШСАЙТ.RU/{brand}/{article} |
| data-target | new_window | Открывать результат в новой вкладке |
Зарезервируйте под каталог место заранее: задайте контейнеру min-height или aspect-ratio. Пока скрипт грузится, высота блока меняется, и без резерва страница дёрнется.
Справочник методов
| Метод | Что возвращает | Расходует запрос |
|---|---|---|
| POST /v1/vehicles/by-vin | Марка, модель, модификация, идентификатор автомобиля | Да |
| POST /v1/vehicles/search | Список машин по марке, модели и году | Нет |
| GET /v1/units | Дерево узлов найденного автомобиля | Нет |
| GET /v1/units/{id}/scheme | Схема узла и координаты выносок | Нет |
| GET /v1/parts/{id} | Артикул, наименование, применимость | Нет |
| GET /v1/quota | Остаток пакета и дата обнуления | Нет |
Запрос расходуется только при определении нового автомобиля. Всё, что происходит внутри найденной машины в течение 24 часов, бесплатно.
Коды и что с ними делать
| Код | Что означает | Что делать |
|---|---|---|
| 401 | Ключ не передан или недействителен | Проверьте заголовок X-Api-Key |
| 403 / 1002 | Домен не авторизован для этого ключа | Добавьте домен в настройках или напишите менеджеру. На localhost ключ намеренно не работает |
| 404 | Автомобиль по VIN не найден | Предложите покупателю подбор по марке и модели |
| 422 | VIN не прошёл проверку формата | Покажите подсказку: 17 символов, без букв I, O, Q |
| 429 | Превышена частота запросов | Повторите через интервал из заголовка Retry-After |
| 402 | Пакет исчерпан | Каталог продолжает отдавать кешированные автомобили. Свяжитесь с менеджером |
Каталог не загрузился
- Проверьте доменКлюч привязан к домену. Поддомены и тестовые стенды нужно добавлять отдельно.
- Посмотрите консольОшибка 1002 означает, что домен не в списке. Это не сбой, а защита ключа.
- Проверьте, что контейнер одинДва блока с одинаковым идентификатором на странице — каталог поднимется только в первом.
- Content Security PolicyЕсли на сайте настроен CSP, разрешите домен скрипта каталога и Cloudflare Turnstile.
- БлокировщикиНекоторые расширения режут сторонние скрипты. Проверьте в приватном окне.
- Ничего не помоглоНапишите на post@goodvin.net и приложите адрес страницы и снимок консоли — ответим в тот же рабочий день.
Частое
Можно поставить два каталога на одну страницу?
Нет. Скрипт ищет контейнер по фиксированному идентификатору, поэтому экземпляр может быть только один. Если нужно переключение между режимами, используйте API или разнесите каталоги по разным страницам.
Как добавить тестовый домен?
Напишите менеджеру список доменов, включая поддомены стенда. Ограничений по количеству нет.
Виджет мешает индексации?
Содержимое каталога отрисовывается скриптом и в индекс не попадает. Если вам нужны индексируемые страницы подбора, берите API и рендерите их на своей стороне.
Нужен ключ, чтобы попробовать
Тестовый ключ на 3 дня и sandbox для API приходят на почту.