{"id":18899196,"url":"https://github.com/miron-anosov/referapi","last_synced_at":"2026-04-05T08:35:40.216Z","repository":{"id":259945962,"uuid":"879887660","full_name":"Miron-Anosov/ReferAPI","owner":"Miron-Anosov","description":"Referral API with JWT","archived":false,"fork":false,"pushed_at":"2024-11-08T21:24:46.000Z","size":104,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-08T19:13:17.713Z","etag":null,"topics":["asyncio","black","docker-compose","fastapi","flake8","gunicorn","isort","jwt","mypy","poetry","postgresql","pre-commit","python","redis","sqlalchemy"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Miron-Anosov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-10-28T18:11:01.000Z","updated_at":"2025-03-05T18:40:13.000Z","dependencies_parsed_at":"2025-05-24T09:10:23.151Z","dependency_job_id":"312c33bc-8d78-438d-bc1a-e62ed4d09c9a","html_url":"https://github.com/Miron-Anosov/ReferAPI","commit_stats":null,"previous_names":["miron-anosov/referapi"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Miron-Anosov/ReferAPI","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Miron-Anosov%2FReferAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Miron-Anosov%2FReferAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Miron-Anosov%2FReferAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Miron-Anosov%2FReferAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Miron-Anosov","download_url":"https://codeload.github.com/Miron-Anosov/ReferAPI/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Miron-Anosov%2FReferAPI/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31430009,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T08:13:15.228Z","status":"ssl_error","status_checked_at":"2026-04-05T08:13:11.839Z","response_time":75,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asyncio","black","docker-compose","fastapi","flake8","gunicorn","isort","jwt","mypy","poetry","postgresql","pre-commit","python","redis","sqlalchemy"],"created_at":"2024-11-08T08:45:51.369Z","updated_at":"2026-04-05T08:35:40.078Z","avatar_url":"https://github.com/Miron-Anosov.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Referral API Service\n\n## Описание\nПростой RESTful API сервис для реферальной системы, который позволяет пользователям регистрироваться, аутентифицироваться, создавать и использовать реферальные коды. Проект построен с использованием современных технологий и фокуса на чистоту, читаемость кода и устойчивость к неправильным действиям пользователя.\n\n## Функциональные возможности\n\n### Основные функции:\n- **Регистрация и аутентификация пользователя** (JWT, OAuth 2.0)\n- **Управление реферальным кодом**: аутентифицированный пользователь может создать или удалить свой реферальный код. В один момент времени активен только один код. При создании кода обязательно указывается срок его действия.\n- **Запрос реферального кода по email реферера**\n- **Регистрация по реферальному коду**: пользователи могут зарегистрироваться с использованием реферального кода, становясь рефералами.\n- **Получение информации о рефералах** по `id` реферера\n\n\n## Структура API\n- **POST /api/user/new**: Регистрация нового пользователя c возможностью отправить реферальный код.\n- **POST /api/user/referral**: Создание нового реферального кода (требует аутентификации)\n- **DELETE /api/user/referral**: Удаление текущего реферального кода пользователя (требует аутентификации)\n- **GET /api/user/referral?user_id=id**: Получение информации о рефералах по id реферера\n- **GET /api/user/referral/email**: Получение реферального кода по email реферера\n\n- **POST /api/auth/login**: Аутентификация пользователя и получение токена JWT\n- **POST /api/auth/token**: Обновление токена JWT по refresh JWT\n- **POST /api/auth/logout**: Удаление refresh JWT из куков.\n\n\n## Как Запустить?\n\n#### Получаем исходники:\n```shell\ngit clone https://github.com/Miron-Anosov/ReferAPI.git\n```\n\n#### Создаем приватный ключ необходимый для JWT\n```shell\nopenssl genrsa -out jwt-private.pem 2048\n```\n\n#### Теперь создаем на его основании публичный ключ.\n\n```shell\nopenssl rsa  -in src/certs/jwt-private.pem -outform PEM -pubout -out jwt-public.pem\n```\n\n####  Применяем .env.template\n\n- Создаем `.env`\n- Вписываем чувствительные данные в `.env` по шаблону `.env.template`\n- В том числе сгенерированные ключи в соответсвующее поля.\n\n#### Запускаем докер:\n```shell\ncd ./.;\ndocker compose up -d\n```\n\n####  Проверяем по адресу Swagger:\nhttp://your-url:80/api/docs\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmiron-anosov%2Freferapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmiron-anosov%2Freferapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmiron-anosov%2Freferapi/lists"}