Кіріспе

HitKey дегеніміз не?

HitKey — бұл OAuth2 сәйкестік платформасы. Ол пайдаланушыларыңызға бір HitKey аккаунтымен барлық серіктес қосымшаларда кіруге мүмкіндік береді — «Google арқылы кіру» сияқты, бірақ HitKey экожүйесіне арналған.

Әзірлеуші ретінде сіз HitKey-ді стандартты OAuth2 Authorization Code Flow арқылы интеграциялайсыз. HitKey мынаны басқарады:

• Пайдаланушы тіркелуі (3 қадамды электрондық пошта верификациясы)
• Аутентификация (кіру, 2FA)
• Пайдаланушы профилін басқару (аттар, электрондық пошталар, параметрлер)
• Авторизация (scopes, жоба деңгейіндегі рұқсаттар)

Сіздің қосымшаңыз тек мынаны істеуі керек:

1. Пайдаланушыларды кіру үшін HitKey-ге бағыттау
2. Авторизация кодын токендерге айырбастау
3. Пайдаланушы профилін алу үшін /oauth/userinfo шақыру

Негізгі тұжырымдамалар

Сәйкестік, email емес

HitKey адамдарды анықтайды, электрондық пошта мекенжайларын емес. Тұрақты идентификатор — sub (UUID) — ешқашан email-ді бірегей кілт ретінде пайдаланбаңыз. Толығырақ.

OAuth2 Authorization Code Flow

HitKey серверлік қосымшалар үшін ең қауіпсіз OAuth2 ағынын пайдаланады. Сіздің бэкенд авторизация кодын access және refresh токендерге айырбастайды. Толық ағынды қараңыз.

Scopes

Тек қажетті деректерді сұраңыз: openid (міндетті), profile (аттар), email (электрондық пошта мекенжайы), project:read (жоба мүшелігі). Scopes анықтамасы.

Жобалар

OAuth клиенттеріңізді жобалар бойынша ұйымдастырыңыз. Рөлдермен (owner, admin, member) және реттелетін рұқсаттармен топ мүшелерін қосыңыз. Жобалар құжаттамасы.

Архитектура

┌─────────────┐     ┌─────────────────┐     ┌──────────────┐
│  Сіздің     │────▶│  HitKey Frontend │────▶│  HitKey API  │
│  қосымшаңыз │◀────│  (Кіру UI)       │◀────│  (OAuth2)    │
└─────────────┘     └─────────────────┘     └──────────────┘

• HitKey API (api.hitkey.io) — OAuth2 сервер, пайдаланушыларды басқару, жобаларды басқару
• HitKey Frontend (hitkey.io) — Кіру/тіркелу UI, пайдаланушы бақылау тақтасы
• Сіздің қосымшаңыз — пайдаланушыларды HitKey-ге бағыттайды, кодтарды токендерге айырбастайды

Бастау

Интеграциялауға дайынсыз ба? Жылдам бастау нұсқаулығынан бастаңыз — 5 минутта жұмыс істейтін OAuth2 ағынын аласыз.