Categorygithub.com/fanfaronDo/referral_system_api
repository
0.0.0-20241023185006-f596f2eb60eb
Repository: https://github.com/fanfarondo/referral_system_api.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# README

API Создания реферальных кодов, хранения и регистрация по ним.

Функциональные требования:

  • Регистрация и аутентификация пользователя (JWT, Oauth 2.0);
  • Аутентифицированный пользователь должен иметь возможность создать или удалить свой реферальный код.Одновременно может быть активен только 1 код. При создании кода обязательно должен быть задан его срок годности;
  • Возможность получения реферального кода по email адресу реферера;
  • Возможность регистрации по реферальному коду в качестве реферала;
  • Получение информации о рефералах по id реферера;
  • UI документация (Swagger/ReDoc)

Необходимо задать переменные окружения:


POSTGRES_USER=postgres
POSTGRES_PASSWORD=*****

Пример запуска приложения:

docker-compose up -d

Описание API доступно в спецификации

ReferralsAPI.postman_collection.json