Skip to content
API дар марҳилаи beta аст ва бидуни огоҳии пешакӣ тағйир ёфта метавонад.

Муқаддима

HitKey чист?

HitKey як платформаи ҳувияти OAuth2 аст. Он ба корбарони шумо имконият медиҳад, ки бо як ҳисоби ягонаи HitKey ба ҳамаи барномаҳои шарикон ворид шаванд — монанди "Sign in with Google", вале барои экосистемаи HitKey сохта шудааст.

Ҳамчун барномасоз, шумо HitKey-ро ба барномаатон тавассути ҷараёни стандартии OAuth2 Authorization Code ҳамгиро мекунед. HitKey идора мекунад:

  • Бақайдгирии корбарон (тасдиқи email дар 3 қадам)
  • Тасдиқи ҳувият (даромадан, 2FA)
  • Идоракунии профили корбар (номҳо, email-ҳо, танзимот)
  • Авторизатсия (scopes, иҷозатҳо дар сатҳи лоиҳа)

Барномаи шумо танҳо бояд:

  1. Корбаронро ба HitKey барои даромадан равона кунад
  2. Authorization code-ро ба token-ҳо иваз кунад
  3. /oauth/userinfo-ро даъват кунад, то профили корбарро гирад

Мафҳумҳои асосӣ

Ҳувият, на email

HitKey одамонро муайян мекунад, на суроғаҳои email-ро. Идентификатори устувор sub (UUID) аст — ҳеҷ гоҳ email-ро ҳамчун калиди ягона истифода набаред. Маълумоти бештар.

OAuth2 Authorization Code Flow

HitKey бехатартарин ҷараёни OAuth2-ро барои барномаҳои серверӣ истифода мебарад. Backend-и шумо authorization code-ро ба access ва refresh token-ҳо иваз мекунад. Ҷараёни пурраро бубинед.

Scopes

Танҳо маълумоти заруриро дархост кунед: openid (ҳатмӣ), profile (номҳо), email (суроғаи email), project:read (узвият дар лоиҳа). Маълумотномаи scopes.

Лоиҳаҳо

OAuth clients-и худро дар лоиҳаҳо ташкил диҳед. Аъзоёни дастаро бо нақшҳо (owner, admin, member) ва иҷозатҳои фардӣ илова кунед. Ҳуҷҷатҳои лоиҳаҳо.

Меъморӣ

┌─────────────┐     ┌─────────────────┐     ┌──────────────┐
│  Your App   │────▶│  HitKey Frontend │────▶│  HitKey API  │
│  (Client)   │◀────│  (Login UI)      │◀────│  (OAuth2)    │
└─────────────┘     └─────────────────┘     └──────────────┘
  • HitKey API (api.hitkey.io) — сервери OAuth2, идоракунии корбарон, идоракунии лоиҳаҳо
  • HitKey Frontend (hitkey.io) — UI-и даромадан/бақайдгирӣ, панели корбар
  • Барномаи шумо — корбаронро ба HitKey равона мекунад, code-ҳоро ба token-ҳо иваз мекунад

Оғоз

Омодаи ҳамгиросозӣ? Бо дастури Оғози зуд оғоз кунед — шумо дар 5 дақиқа ҷараёни кории OAuth2-ро хоҳед дошт.

HitKey Service License.