Введение

Что такое HitKey?

HitKey — это OAuth2 платформа идентификации. Она позволяет вашим пользователям входить с единым аккаунтом HitKey во все партнёрские приложения — аналогично «Войти через Google», но для экосистемы HitKey.

Как разработчик, вы интегрируете HitKey через стандартный OAuth2 Authorization Code flow. HitKey берёт на себя:

• Регистрацию пользователей (3-шаговая верификация email)
• Аутентификацию (логин, 2FA)
• Управление профилем (имена, email, настройки)
• Авторизацию (scopes, разрешения на уровне проектов)

Вашему приложению нужно только:

1. Перенаправить пользователей на HitKey для входа
2. Обменять authorization code на токены
3. Вызвать /oauth/userinfo для получения профиля

Ключевые концепции

Идентичность, а не email

HitKey идентифицирует людей, а не email-адреса. Стабильный идентификатор — sub (UUID). Никогда не используйте email как уникальный ключ. Подробнее.

OAuth2 Authorization Code Flow

HitKey использует самый безопасный OAuth2-flow для серверных приложений. Ваш бэкенд обменивает authorization code на 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, обменивает коды на токены

Начало работы

Готовы к интеграции? Начните с Быстрого старта — рабочий OAuth2-flow за 5 минут.