Аутентификация (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>.
Как получить#
- Войдите в Relay Dashboard.
- Вкладка API keys → Create key (отдельный ключ на prod / staging / local).
- Скопируйте значение один раз; при утечке — revoke и создайте новый.
На портале#
Приоритет чтения прокси /api/proxy/relay:
- Файл
data/relay.api-key(через/api-keys-install, вкладка Relay; права 0o600). - Переменная окружения
RELAY_API_KEY(см..env.example).
- Браузер никогда не видит ключ (после сохранения UI показывает только намёк «…последние 6»).
- Клиентские заголовки Authorization / x-api-key отбрасываются.
- В ответе прокси — маркер
x-relay-auth: key|anonymous.
# .env (не коммитить реальный ключ)
RELAY_API_KEY=
Чеклист: Продакшен.
Безопасность#
- Не кладите ключ в markdown, шаблоны JSON, клиентский бандл или git.
- Подробнее: Безопасность и секреты.