Аутентификация (x-api-key)

Официально: API keys and Rate Limits

Кратко#

  • Ключ опционален для большинства публичных эндпоинтов (/chains, /quote/v2, /currencies/v2, /intents/status/v3).
  • С ключом — выше rate limits и атрибуция запросов в Dashboard.
  • Если в теле котировки задан referrer, ключ обязателен: иначе 401 с errorCode: "UNAUTHORIZED_QUOTE".
  • Ключ передаётся только в заголовке: x-api-key: <key>.

Как получить#

  1. Войдите в Relay Dashboard.
  2. Вкладка API keys → Create key (отдельный ключ на prod / staging / local).
  3. Скопируйте значение один раз; при утечке — revoke и создайте новый.

На портале#

Приоритет чтения прокси /api/proxy/relay:

  1. Файл data/relay.api-key (через /api-keys-install, вкладка Relay; права 0o600).
  2. Переменная окружения RELAY_API_KEY (см. .env.example).
  • Браузер никогда не видит ключ (после сохранения UI показывает только намёк «…последние 6»).
  • Клиентские заголовки Authorization / x-api-key отбрасываются.
  • В ответе прокси — маркер x-relay-auth: key|anonymous.
# .env (не коммитить реальный ключ)
RELAY_API_KEY=

Чеклист: Продакшен.

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