Relavio Docs

Appearance

API-ключи ​

API-ключ нужен для подключения виджета Relavio Search и выполнения запросов к публичному API. По ключу Relavio определяет магазин, его поисковый индекс, настройки и доступные лимиты.

Страница API-ключа Relavio

Где найти API-ключ ​

  1. Войдите в личный кабинет Relavio.
  2. Откройте раздел Магазины.
  3. Выберите нужный магазин из списка.
  4. На странице просмотра магазина откройте вкладку API.
  5. Скопируйте значение из поля API key.

Этот ключ используется в виджете и API-запросах для конкретного магазина.

Где используется API-ключ ​

API-ключ нужен для:

  • подключения JavaScript-виджета поиска;
  • запросов к Search API;
  • запросов к Suggest API;
  • отправки событий аналитики;
  • проверки интеграции через Swagger.

Использование в виджете ​

Передайте ключ в атрибуте data-api-key:

html
<div
    data-relavio-search-widget
    data-api-key="YOUR_API_KEY"
    data-behavior="suggests"
></div>

<script src="https://relavio.su/js/search-widget.js"></script>

После этого виджет будет отправлять ключ в заголовке api-key при обращении к API.

Использование в API ​

При прямой интеграции передавайте ключ в HTTP-заголовке:

http
api-key: YOUR_API_KEY

Пример запроса:

bash
curl -X POST "https://relavio.su/api/v1/search" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "api-key: YOUR_API_KEY" \
    -d '{"query":"iphone","page":1,"per_page":20}'

Проверка через Swagger ​

Откройте Swagger-документацию, выберите нужный endpoint и укажите API-ключ в заголовке api-key.

Swagger удобно использовать, чтобы быстро проверить:

  • работает ли ключ;
  • возвращаются ли товары;
  • есть ли подсказки;
  • принимаются ли события аналитики.

Безопасность ​

API-ключ относится к конкретному магазину. Храните его аккуратно и не публикуйте в местах, где его могут использовать посторонние.

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

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

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

Если API-ключ не работает ​

Проверьте:

  1. Ключ скопирован полностью, без пробелов в начале или конце.
  2. Запрос отправляется с заголовком api-key.
  3. Вы используете ключ нужного магазина.
  4. Магазин активен и импорт товаров был выполнен.
  5. Домен и endpoint указаны корректно.

Если API возвращает 401 Unauthorized, ключ отсутствует, указан неверно или не найден в платформе.

Следующие разделы ​