Тіркелу

HitKey электрондық пошта верификациясымен 3 қадамды тіркелу ағынын пайдаланады.

Ағынға шолу

sequenceDiagram
    participant U as Пайдаланушы
    participant A as HitKey API
    participant E as Электрондық пошта

    U->>A: POST /auth/register/start {email}
    A->>E: 6 санды код жіберу
    A->>U: 200 OK

    U->>A: POST /auth/register/verify {email, code}
    A->>U: 200 OK (email верификацияланды)

    U->>A: POST /auth/register/password {email, password}
    A->>U: Bearer токен (автоматты кіру)

1-қадам: Тіркелуді бастау

curl -X POST https://api.hitkey.io/auth/register/start \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com"}'

Электрондық пошта мекенжайына 6 санды верификация коды жіберіледі.

Код қасиеттері:

• 10 минут жарамды
• Максимум 3 верификация әрекеті
• 60 секунд кідірістен кейін қайта жіберуге болады

2-қадам: Email-ді верификациялау

curl -X POST https://api.hitkey.io/auth/register/verify \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com", "code": "123456"}'

Қателер:

Код	Сипаттама
INVALID_CODE	Қате верификация коды
CODE_EXPIRED	Код мерзімі аяқталған (10 мин)
TOO_MANY_ATTEMPTS	3 сәтсіз әрекет — жаңа код сұраңыз
NO_CODE	Бұл email үшін күтілетін верификация жоқ
EMAIL_ALREADY_VERIFIED	Email бұрыннан верификацияланған

3-қадам: Құпия сөзді орнату

curl -X POST https://api.hitkey.io/auth/register/password \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "secure_password"
  }'

Сәтті болғанда пайдаланушы автоматты түрде кіреді және Bearer токен алады:

Жауап 200:

{
  "message": "Registration completed",
  "type": "bearer",
  "token": "hitkey_...",
  "refresh_token": "a1b2c3d4e5f6...",
  "expires_in": 3600,
  "user": {
    "id": "uuid",
    "email": "user@example.com",
    "displayName": "user"
  }
}

Кодты қайта жіберу

curl -X POST https://api.hitkey.io/auth/register/resend \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com"}'

Кідіріс

Қайта жіберу эндпоинтінде теріс пайдалануды болдырмау үшін 60 секундтық кідіріс бар. Фронтенд кері санақ таймерін көрсетуі тиіс.

Шақыру арқылы тіркелу

Жобаға шақырылған пайдаланушылар бір қадамда тіркеле алады:

curl -X POST https://api.hitkey.io/auth/register/with-invite \
  -H "Content-Type: application/json" \
  -d '{
    "invite_token": "INVITE_TOKEN",
    "email": "user@example.com",
    "password": "secure_password"
  }'

Бұл email верификациясын өткізіп жібереді (шақыру дәлел ретінде қызмет етеді) және пайдаланушыны автоматты түрде жобаға қосады.

Жауап 200:

{
  "token": "hitkey_...",
  "refresh_token": "a1b2c3d4e5f6...",
  "expires_in": 3600,
  "user": {
    "id": "uuid",
    "email": "user@example.com",
    "displayName": "user"
  },
  "project_slug": "my-app",
  "redirect_url": "https://myapp.com/welcome"
}