Реализация реферальной системы на Django

Тестирование с помощью Postman

Для удобного тестирования API можно использовать данную коллекцию Postman

Описание функционала API

1. Запрос кода авторизации

Endpoint: POST /auth/request-code/ Описание: Запрос отправки 4-значного кода авторизации на номер телефона Тело запроса:

{
    "phone_number": "79994445566"
}

Ответы сервера:

Успех

{
    "status": "success",
    "message": "Код отправлен",
}

Ошибка (Не указан номер телефона)

{
    "error": "Необходимо указать номер телефона"
}

2. Проверка кода авторизации

Endpoint: POST /auth/verify-code/ Описание: Проверка 4-значного кода для завершения авторизации Тело запроса:

{
    "phone_number": "79994445566",
    "code": "7543"
}

Ответы сервера:

Успех

{
    "status": "success",
    "token": "<jwt_token>",
    "is_new_user": false
}

Ошибка (Не указан номер телефона)

{
    "error": "Необходимо указать номер телефона"
}

Ошибка (Не указан код подтверждения)

{
    "error": "Необходимо указать код подтверждения"
}

Ошибка (Неверный код или код уже использован)

{
    "error": "Неверный код или код уже использован"
}

3. Получение профиля пользователя

Endpoint: GET /profile/ Описание: Получение сведений профиля пользователя Headers: Authorization: Bearer <jwt_token> Ответ сервера:

Успех

{
    "phone_number": "79993334455",
    "invite_code": "yIFpAl",
    "activated_invite": null,
    "invited_users": [
        "79996667788"
    ]
}

4. Активация реферального кода

Endpoint: POST /profile/activate-invite/ Описание: Активация реферального кода Headers: Authorization: Bearer <jwt_token> Тело запроса:

{
    "invite_code": "Tok2w1",
}

Ответы сервера:

Успех

{
    "status": "success",
    "message": "Инвайт-код активирован"
}

Ошибка (Инвайт-код уже активирован)

{
    "error": "Инвайт уже был активирован",
}

Ошибка (Попытка активации собственного кода)

{
    "error": "Нельзя активировать собственный инвайт-код",
}

Ошибка (Инвайт-код не найден)

{
    "error": "Инвайт-код не найден",
}