From 21d8ba5b3e216588436e3a31a7b44635f3eaf94d Mon Sep 17 00:00:00 2001 From: Red Date: Sat, 27 Sep 2025 02:20:51 +0500 Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=B8=D1=82?= =?UTF-8?q?=D1=8C=20Home?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Home.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 Home.md diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..4a016ed --- /dev/null +++ b/Home.md @@ -0,0 +1,37 @@ +# Краткое руководство +### Суть +Предполагается, что: + +1. Сервис будет запускаться локально (извне обращения игнорироваться). +2. Использоваться для благих целей. + +### Как пользоваться +Пользоваться им очень просто, как два пальца об асфальт. + +#### Для создания ключа: +Нужно обратиться к /reg-key с такой структурой: +``` +POST /reg-key +body: { + "name": "Example", + "update": 24 +} +``` + +где: +- update - интервал обновления +- name - название ключа + +#### Для получения ключа: +Тут тоже все просто, отличие лишь в способе передачи информации: +``` +GET /get-key +query-параметры: + - name + - kid (опционально) + +примеры: + - http://localhost/get-key?name=Example + - http://localhost/get-key?name=Example&kid=4adc0149-49e7-45e7-b0af-5e0c4da5fe3f +``` +Все, это все что вам нужно знать, чтобы использовать этот сервис.