Skip to content
API beta кезеңінде және алдын ала ескертусіз өзгеруі мүмкін.

Токен түрлері

HitKey бірнеше түрлі токендерді пайдаланады. Айырмашылықты түсіну дұрыс интеграция үшін маңызды.

OAuth2 токендер

Бұлар OAuth2 ағыны арқылы шығарылады және пайдаланушы атынан HitKey API-ге қол жеткізу үшін пайдаланылады.

Access Token

ҚасиетМәні
Мерзімі1 сағат
ҚолданылуыAuthorization: Bearer <token> тақырыбы
Эндпоинт/oauth/userinfo
Алу жолы/oauth/token (код айырбастау немесе жаңарту)

Access токендер қысқа мерзімді. Бірі аяқталғанда, жаңасын алу үшін refresh токенді пайдаланыңыз.

Refresh Token

ҚасиетМәні
Жылжымалы терезе30 күн (әр пайдаланғанда қалпына келеді)
Абсолютті шек90 күн (максималды мерзім)
ҚолданылуыPOST /oauth/token grant_type=refresh_token мәнімен
РотацияЖоқ — сол refresh токен жарамды болып қалады

INFO

OAuth refresh токендер ротацияланбайды — сол refresh токенді мерзімі аяқталғанша қайта пайдалануға болады. Тек access токен жаңартылады.

Бұл API Bearer токенді жаңартудан (POST /auth/token/refresh) ерекшеленеді, ол refresh токенді ротациялайды.

Authorization Code

ҚасиетМәні
Мерзімі10 минут
ҚолданылуыБір реттік, access + refresh токенге айырбасталады
АғыныПайдаланушы авторизациясынан кейін redirect арқылы алынады

API Bearer токендер

Бұлар HitKey-дің ішкі аутентификация токендері, тікелей API қолжетімділік үшін пайдаланылады (OAuth2 емес).

ҚасиетМәні
Шығарылу жолыPOST /auth/login
Префиксhitkey_
ҚолданылуыAuthorization: Bearer <token> тақырыбы
ЭндпоинттерБарлық /auth/*, /projects/*, /oauth/clients
ЖаңартуPOST /auth/token/refresh — refresh токенді ротациялайды

Қайсысын қашан пайдалану

  • OAuth2 токендер — сіздің қосымшаңыз пайдаланушы атынан HitKey-ге кірген кезде (стандартты серіктес интеграция)
  • API Bearer токендер — пайдаланушы HitKey-мен тікелей әрекеттескенде (HitKey бақылау тақтасы осыларды пайдаланады)

Серіктес әзірлеуші ретінде сіз негізінен OAuth2 токендермен жұмыс істейсіз.

Токенді сақтау ұсыныстары

ТокенҚайда сақтауЕскертулер
Access tokenЖад немесе қауіпсіз сақтауҚысқа мерзімді, қайта алуға болады
Refresh tokenСервер жағындағы қауіпсіз сақтауЕшқашан фронтендке көрсетпеңіз
Client secretОрта айнымалысыЕшқашан кодта немесе фронтендте

Токен қауіпсіздігі

  • Авторизация кодтары сақталар алдында хэштеледі (SHA-256) — API тек хэшті сақтайды
  • Access және refresh токендер де хэш ретінде сақталады
  • Ашық мәтіндегі токендер тек жасалған кезде бір рет қайтарылады
  • Токен айырбастау client_id мен client_secret екеуін де талап етеді

HitKey Service License.