{"id":34222404,"url":"https://github.com/kiryu2k/segments-api","last_synced_at":"2026-03-10T08:33:12.696Z","repository":{"id":191646996,"uuid":"684667053","full_name":"kiryu2k/segments-api","owner":"kiryu2k","description":null,"archived":false,"fork":false,"pushed_at":"2023-08-31T05:18:15.000Z","size":86,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-06-21T19:53:18.575Z","etag":null,"topics":["rest-api","segment-api"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kiryu2k.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2023-08-29T15:56:45.000Z","updated_at":"2024-04-04T13:20:38.000Z","dependencies_parsed_at":"2024-06-09T15:39:16.505Z","dependency_job_id":"b65ea37a-6161-4ee9-a49c-e40dc9dbb9d2","html_url":"https://github.com/kiryu2k/segments-api","commit_stats":null,"previous_names":["kiryu-dev/segments-api","kiryu2k/segments-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/kiryu2k/segments-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiryu2k%2Fsegments-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiryu2k%2Fsegments-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiryu2k%2Fsegments-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiryu2k%2Fsegments-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kiryu2k","download_url":"https://codeload.github.com/kiryu2k/segments-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiryu2k%2Fsegments-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30328251,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T05:25:20.737Z","status":"ssl_error","status_checked_at":"2026-03-10T05:25:17.430Z","response_time":106,"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":["rest-api","segment-api"],"created_at":"2025-12-15T23:40:12.101Z","updated_at":"2026-03-10T08:33:11.464Z","avatar_url":"https://github.com/kiryu2k.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Segments API\nSegments API — сервис, хранящий пользователей и сегменты, в которых они состоят (создание, удаление сегментов, а также добавление и удаление пользователей в сегмент).\n## Usage\nДля поднятия и развертывания dev-среды выполнить:\n```\ndocker-compose -f docker-compose.dev.yaml up\n```\nЛокально:\n```\ndocker-compose -f docker-compose.local.yaml up\n```\nСборка и запуск приложения (по умолчанию загружается конфигурация для dev-среды):\n```\nmake\n```\nСборка и запуск приложения с конфигурацией для local-среды:\n```\nmake build\n./bin/segments --config ./configs/config.local.yaml\n```\nИзменить конфигурацию для той или иной среды можно в файлах `config.dev.yaml` и `config.local.yaml` в директории `./configs`. Также обязательно создать `.env` файл с необходимыми переменными окружения (смотри `example.env`).\n## Endpoints\n**Swagger документация**:\n```\nGET /docs/index.html\n```\n**Метод создания сегмента.** Принимает в body slug (название) сегмента. Опционально можно указать процент пользователей, которые добавятся в этот сегмент автоматически:\n```\nPOST /segment\n```\n**Метод удаления сегмента.** Принимает slug (название) сегмента:\n```\nDELETE /segment/{slug}\n```\n**Метод создания пользователя.** Принимает в body id пользователя:\n```\nPOST /user\n```\n**Метод изменения активных сегментов пользователя.** Принимает в body список slug (названий) сегментов которые нужно добавить пользователю, \nсписок slug (названий) сегментов которые нужно удалить у пользователя, id пользователя. Также есть возможность задать TTL для добавляемых сегментов, \nчтобы по истечению времени они автоматически удалились у пользователя. TTL задается в формате \"1y8m21d\". \nЕсли хотите только удалить определенные сегменты, то можно опустить список сегментов для добавления и наоборот:\n```\nPOST /user-segments\n```\n**Метод получения активных сегментов пользователя.** Принимает на вход id пользователя:\n```\nGET /user-segments/{userID}\n```\n**Метод удаления пользователя.** Принимает на вход id пользователя:\n```\nDELETE /user/{userID}\n```\n**Метод получения истории добавления и удаления** сегментов указанного пользователя за определенные год и месяц (указываются в query параметрах в численном виде) в формате CSV:\n```\nGET /log/{userID}?date={year-month}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkiryu2k%2Fsegments-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkiryu2k%2Fsegments-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkiryu2k%2Fsegments-api/lists"}