4. API токені

Токенді тақырыптарда беру және қолжетімділікті /os/v1/me сұрауымен тексеру.

Әрбір сұрауда токен мына тақырыптардың бірінде берілуге тиіс:

Authorization: Bearer <токен> — токенді берудің негізгі тәсілі;
x-api-key: <токен> — балама тәсіл, оны, атап айтқанда, Anthropic SDK пайдаланады.

Токенді мекенжай жолында беруге қолдау көрсетілмейді: мұндай сұрау токенсіз сұрау ретінде қарастырылады.

curl https://api.bbx.kz/os/v1/me \
  -H "Authorization: Bearer qos_YOUR_TOKEN"

# The same token in the x-api-key header
curl https://api.bbx.kz/os/v1/me \
  -H "x-api-key: qos_YOUR_TOKEN"

Токен болмаған, қате көрсетілген немесе кері қайтарып алынған жағдайда invalid_api_key кодымен 401 жауабы, қолданылу мерзімі аяқталғанда token_expired кодымен 401 жауабы, токен бұғатталғанда token_blocked кодымен 403 жауабы қайтарылады.

Бір IP-мекенжайдан 10 минут ішінде авторизацияның 30 сәтсіз әрекетінен кейін осы мекенжайдан түскен сұраулар 15 минут бойы too_many_auth_failures кодымен қабылданбайды.

4.1. Токен туралы мәліметтер

GET /os/v1/me сұрауы токен туралы мәліметтерді және оның ағымдағы айдағы пайдаланылу статистикасын қайтарады. Сұрау ешбір модульге қолжетімділікті талап етпейді және интеграцияның жұмысқа қабілеттілігін тексеру үшін қолданылады.

JSON

{
  "token": {
    "name": "Student services integration",
    "prefix": "qos_Xk2Lp9aQ",
    "modules": ["ALEM", "ACADEMIC", "SCHEDULING"],
    "rpmLimit": 120,
    "expiresAt": "2027-06-30T23:59:59Z"
  },
  "usage": {
    "month": "2026-10",
    "requests": 1842,
    "totalTokens": 512300
  }
}

Жауап өрістері:

token.name — токен атауы;
token.prefix — токенді сәйкестендіруге арналған бастапқы таңбалары;
token.modules — қолжетімді модульдердің кодтары;
token.rpmLimit — минутына рұқсат етілген сұраулар саны немесе шектеу белгіленбесе, null;
token.expiresAt — токеннің қолданылу мерзімі аяқталатын күн мен уақыт немесе мерзім шектелмесе, null;
usage — ағымдағы айдағы сұраулар саны және модельдер жұмсаған токендер саны.