02 Руководства

Ключ API и заголовки

Один ключ на клиента, в одном заголовке. Ключ работает из любой страны и с любого сервера.

Ключ в заголовке

Каждый запрос к данным передаёт ключ в заголовке X-API-Key. Ключ хранится у нас только в виде хеша; потерянный ключ перевыпускается в боте — старый работает ещё 24 часа, квота не сбрасывается.

curl
curl -s "https://api.apiauto.space/v1/usage" \
  -H "X-API-Key: $APIAUTO_KEY"

Без ключа или с неверным ключом ответ — 401 unauthorized; все коды — в разделе Коды ошибок API.

Ключ — только на сервере

API не разрешает запросы из браузера (CORS выключен): ключ в коде страницы увидел бы любой посетитель. Сайт или бот запрашивает API со своего сервера, а клиентам отдаёт уже свои страницы.

Заголовки ответа

Заголовок ответаЧто значит
X-Quota-LimitКвота периода: машин в месяц (в демо — запросов за сутки).
X-Quota-RemainingСколько осталось.
X-Quota-ResetКогда квота обновится, ISO 8601 UTC.
X-RateLimit-LimitЗапросов в секунду по тарифу.
X-RateLimit-RemainingОсталось в текущей секунде.
X-RateLimit-ResetСекунд до сброса счётчика (1).
Retry-AfterПри 429 и некоторых 503: через сколько секунд повторить.
X-Data-Age-SecondsВозраст копии рынка в секундах.

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

  1. Откройте бота@apiautospace_bot в Telegram и нажмите «Запустить».
  2. Возьмите демоСутки, 100 запросов, все три рынка и лента изменений — без карты.
  3. Сохраните ключКлюч приходит отдельным сообщением и показывается один раз.

Получить тестовый ключ