К содержимому

Проверить, действует ли ключ

GET/api/v1/account/status

Доступ
Ключ API

Лёгкая проверка для приложений: 200 { ok, checkAfter }, пока ключ действует, и 401 с кодом первой причины, по которой он больше не работает, — API_KEY_REVOKED, API_KEY_EXPIRED, API_KEY_INVALID, ACCOUNT_BANNED (с reason, если администратор показал причину) или ACCOUNT_ACCESS_CHANGED. Подходит ключ с любыми правами. Приложение lacuna для Windows спрашивает раз в минуту, пока окно открыто, и сразу, когда окно выходит на первый план; ошибки сети, 429 и 5xx ключ не отключают. Ответ для рабочего ключа может браться из памяти сервера до пяти минут, но блокировка и отзыв ключа сбрасывают её сразу. В журнал запросов проверка не пишется. До 20 проверок ключом в минуту.

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

curl "https://lac.pics/api/v1/account/status" \
  -H "Authorization: Bearer lac_api_YOUR_KEY"

Ответы

  • 200ГотовоAccountCheck
    • okbooleanобязательный

      Ключ действует.

      значения: true

    • checkAfterintegerобязательный

      Через сколько секунд проверить снова, пока окно приложения открыто (в трее — вдвое реже).

      от 1

  • 400Некорректный запрос
  • 401Нужен действующий ключBEARER_REQUIRED
  • 413Слишком большой файл или нет места
  • 429Слишком много запросов
  • 500Сбой на сервере
  • 503Сервис занят или недоступен

Пример ответа

200 · application/json
{
  "ok": true,
  "checkAfter": 1
}

Коды ошибок

КодСтатусТекст
BEARER_REQUIRED401Требуется Bearer-ключ.

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

Проверить, действует ли ключ: GET /api/v1/account/status · API lacuna