Документація | Довідник API

Огляд

Партнерська програма дозволяє запрошувати нових користувачів до системи та відстежувати статус запрошень.

Запрошення по email

Надсилайте красиві листи-запрошення на будь-яку мову.

Відстеження статусу

Слідкуйте за статусом кожного запрошення в реальному часі.

Автоматичне підтвердження

Статус автоматично оновлюється при реєстрації запрошеного.

Система винагород

В розробці: бонуси та знижки за кожного залученого користувача.

Статуси запрошень

Кожне запрошення має один з трьох статусів:

Запрошено

Запрошення надіслано, очікуємо на реєстрацію.

Зареєстровано

Запрошений зареєструвався в системі.

Відхилено

Запрошений відмовився від участі.

Як це працює

Простий процес запрошення партнерів:

1

Створіть запрошення

Вкажіть ім'я та email людини, яку хочете запросити.

2

Лист надсилається

Система автоматично надсилає красивий лист-запрошення.

3

Очікуйте реєстрацію

Запрошений отримує лист та може зареєструватися.

4

Статус оновлюється

При реєстрації статус автоматично змінюється на "Зареєстровано".

Що планується

Ми активно працюємо над системою винагород для партнерів:

Бонуси за кожного залученого користувача
Знижки на преміум функції платформи
Ексклюзивний доступ до нових можливостей
Накопичувальна система винагород

REST API

Доступ до партнерських запрошень через REST API (потрібна JWT авторизація):

GET    /api/v1/partner-invitations           - Список запрошень
POST   /api/v1/partner-invitations           - Створити запрошення
GET    /api/v1/partner-invitations/{id}      - Деталі запрошення
POST   /api/v1/partner-invitations/{id}/resend - Надіслати повторно

Приклад запиту

POST /api/v1/partner-invitations
Content-Type: application/json
Authorization: Bearer your-token

{
  "name": "John Doe",
  "email": "[email protected]",
  "locale": "uk"
}

Приклад відповіді

{
  "success": true,
  "message": "Invitation sent successfully",
  "invitation": {
    "id": 1,
    "name": "John Doe",
    "email": "[email protected]",
    "locale": "uk",
    "status": "invited",
    "invited_at": "2026-01-19T12:00:00+00:00"
  },
  "updated": false
}

Swagger / OpenAPI

Повна документація API з інтерактивним тестуванням доступна в Swagger UI: /api/v1/doc