From 856e8e42b0bc1ef77724f1e216b224aec42cd7e0 Mon Sep 17 00:00:00 2001 From: Denis Davydov Date: Wed, 9 May 2018 15:27:25 +0300 Subject: [PATCH] Update API.md --- README.md | 8 +------- API.md => doc/ru/API.md | 30 ++++++++++++++++++++++++------ 2 files changed, 25 insertions(+), 13 deletions(-) rename API.md => doc/ru/API.md (97%) diff --git a/README.md b/README.md index ac7ae34..2387d61 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,3 @@ # HyperboriaIM -**HyperboriaIM** - это защищенный мессенджер, который будет функционировать в сети *Hyperboria* (cjdns). Сам мессенджер будет разделен на две части - серверная часть и клиентская часть. Серверная часть будет функционировать на компьютере пользователя. В серверной части будет реализована вся логика мессенджера. Клиентская часть будет просто вызывать функции (API) серверной. - -### Чат - -При создании чата, будет генерироваться ключ шифрования и отправляться участникам чата (или получателю, если это не групповой чат). После чего, все сообщения в чате будут шифроваться этим ключом шифрования. - -По контактам будет создаваться сколько угодно чатов. Более подробно о технической части [тут](https://github.com/ChronosX88/HyperboriaIM-doc/blob/master/API.md). +**HyperboriaIM** - это защищенный мессенджер, который будет функционировать в сети *Hyperboria* (cjdns). Сам мессенджер будет разделен на две части - серверная часть и клиентская часть. Серверная часть будет функционировать на компьютере пользователя. В серверной части будет реализована вся логика мессенджера. Клиентская часть будет просто вызывать функции (API) серверной. Более подробно о технической части [тут](https://github.com/ChronosX88/HyperboriaIM-doc/blob/master/API.md). diff --git a/API.md b/doc/ru/API.md similarity index 97% rename from API.md rename to doc/ru/API.md index 2436f24..c7b9808 100644 --- a/API.md +++ b/doc/ru/API.md @@ -1,7 +1,7 @@ -Протокол обмена. -=============================== +# Протокол обмена. ## Структура сети: + Связь между узлами - точка-точка GUI - Сервер ==== Сервер - GUI @@ -13,30 +13,37 @@ GUI - примитивная программа под Linux/Window/Android, к На сервере также хранится история переписки. У сервера есть список контактов (друзей), в формате: + ```json { "адрес1": { "nick":"", "last_online":"", "last_connect":"", "can_resend":1, "key":"", "other_info":... } ... } ``` + Поле адрес - это адрес сервера, куда отправляем. Может быть как ipv4, так и ipv6 адрес в сети cjdns. - ## Протокол обмена + Обмен сообщениями ведётся по GET/POST http протоколу в формате JSON, что позволяет делать GUI прямо в браузере. При любой успешной отправке данных обновляем поле last_connect у контакта. Если пришло сообщение от контакта, которого нет в адресной книге - то оно отбрасывается. Исключения - запрос handshake. -1. Добавление в друзья +### Добавление в друзья + Используется, чтобы установить связь с контактом. Тот кто хочет добавиться в друзья - отправляет такой запрос. + ```json { "action":"handshake", "nick": "" } ``` -ответ + +ответ: + ```json { "status": 1 } ``` + У другого абонента висит этот контакт в списке неавторизованных. Если он хочет его тоже добавить в друзья - отправляем ему свой handshake. Возможет вариант, когда сервер автоматически добавляет в друзья (публичный сервер для пересылки offline сообщений). ### Отправка сообщения @@ -46,10 +53,13 @@ GUI - примитивная программа под Linux/Window/Android, к ```json { "action":"send", "from":"адрес", "to":"адрес", "message":"сообщение", "timestamp":"время", "enctype":"" } ``` + ответ: + ```json { "status": 1 } ``` + Сообщение может быть зашифровано, метод шифрования в поле enctype. Если нет ответа, то сохраняем сообщение у себя в истории, чтобы потом переотправить. `status==1` - доставлено, другой - недоставлено (помечаем как недоставлено @@ -61,7 +71,9 @@ GUI - примитивная программа под Linux/Window/Android, к ```json { "action":"ping" } ``` + ответ: + ```json { "action":"pong" } ``` @@ -72,10 +84,13 @@ GUI - примитивная программа под Linux/Window/Android, к ```json { "action": "history", "messages":[{},{},{}...] } ``` + ответ: + ```json { "status":[1,1,1,0,1] } ``` + В ответ приходит массив с 1 или 0. Если 1 - сообщение сохранено успешно, 0 - ошибка и его нужно потом переотправить. ### Отправление сообщения для другого абонента (это нужно чтобы отправлять тем, кто в offline) @@ -87,9 +102,12 @@ GUI - примитивная программа под Linux/Window/Android, к ```json { "action":"resend", ... } ``` + Параметры такие же как и для send ответ + ```json { "status":1 } ``` -Если `status == 0` - то эта нода не желает пересылать сообщения и ей повторно отправлять не нужно. + +Если `status == 0` - то эта нода не желает пересылать сообщения и ей повторно отправлять не нужно. \ No newline at end of file