mirror of
https://github.com/ChronosX88/Influence-cjdns.git
synced 2024-11-08 17:01:00 +00:00
Update API.md
This commit is contained in:
parent
5cd77a8713
commit
3a1a0a07b8
27
API.md
27
API.md
@ -1,7 +1,7 @@
|
|||||||
Протокол обмена.
|
# Протокол обмена.
|
||||||
===============================
|
|
||||||
|
|
||||||
## Структура сети:
|
## Структура сети:
|
||||||
|
|
||||||
Связь между узлами - точка-точка
|
Связь между узлами - точка-точка
|
||||||
|
|
||||||
GUI - Сервер ==== Сервер - GUI
|
GUI - Сервер ==== Сервер - GUI
|
||||||
@ -13,30 +13,36 @@ GUI - примитивная программа под Linux/Window/Android, к
|
|||||||
На сервере также хранится история переписки.
|
На сервере также хранится история переписки.
|
||||||
|
|
||||||
У сервера есть список контактов (друзей), в формате:
|
У сервера есть список контактов (друзей), в формате:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"адрес1": { "nick":"", "last_online":"", "last_connect":"", "can_resend":1, "key":"", "other_info":... }
|
"адрес1": { "nick":"", "last_online":"", "last_connect":"", "can_resend":1, "key":"", "other_info":... }
|
||||||
...
|
...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Поле адрес - это адрес сервера, куда отправляем. Может быть как ipv4, так и ipv6 адрес в сети cjdns.
|
Поле адрес - это адрес сервера, куда отправляем. Может быть как ipv4, так и ipv6 адрес в сети cjdns.
|
||||||
|
|
||||||
|
|
||||||
## Протокол обмена
|
## Протокол обмена
|
||||||
|
|
||||||
Обмен сообщениями ведётся по GET/POST http протоколу в формате JSON, что позволяет делать GUI прямо в браузере.
|
Обмен сообщениями ведётся по GET/POST http протоколу в формате JSON, что позволяет делать GUI прямо в браузере.
|
||||||
При любой успешной отправке данных обновляем поле last_connect у контакта.
|
При любой успешной отправке данных обновляем поле last_connect у контакта.
|
||||||
Если пришло сообщение от контакта, которого нет в адресной книге - то оно отбрасывается.
|
Если пришло сообщение от контакта, которого нет в адресной книге - то оно отбрасывается.
|
||||||
Исключения - запрос handshake.
|
Исключения - запрос handshake.
|
||||||
|
|
||||||
1. Добавление в друзья
|
1. Добавление в друзья
|
||||||
Используется, чтобы установить связь с контактом. Тот кто хочет добавиться в друзья - отправляет такой запрос.
|
Используется, чтобы установить связь с контактом. Тот кто хочет добавиться в друзья - отправляет такой запрос.
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{ "action":"handshake", "nick": "" }
|
{ "action":"handshake", "nick": "" }
|
||||||
```
|
```
|
||||||
|
|
||||||
ответ
|
ответ
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{ "status": 1 }
|
{ "status": 1 }
|
||||||
```
|
```
|
||||||
|
|
||||||
У другого абонента висит этот контакт в списке неавторизованных. Если он хочет его тоже добавить в друзья - отправляем ему свой handshake. Возможет вариант, когда сервер автоматически добавляет в друзья (публичный сервер для пересылки offline сообщений).
|
У другого абонента висит этот контакт в списке неавторизованных. Если он хочет его тоже добавить в друзья - отправляем ему свой handshake. Возможет вариант, когда сервер автоматически добавляет в друзья (публичный сервер для пересылки offline сообщений).
|
||||||
|
|
||||||
### Отправка сообщения
|
### Отправка сообщения
|
||||||
@ -46,10 +52,13 @@ GUI - примитивная программа под Linux/Window/Android, к
|
|||||||
```json
|
```json
|
||||||
{ "action":"send", "from":"адрес", "to":"адрес", "message":"сообщение", "timestamp":"время", "enctype":"" }
|
{ "action":"send", "from":"адрес", "to":"адрес", "message":"сообщение", "timestamp":"время", "enctype":"" }
|
||||||
```
|
```
|
||||||
|
|
||||||
ответ:
|
ответ:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{ "status": 1 }
|
{ "status": 1 }
|
||||||
```
|
```
|
||||||
|
|
||||||
Сообщение может быть зашифровано, метод шифрования в поле enctype.
|
Сообщение может быть зашифровано, метод шифрования в поле enctype.
|
||||||
Если нет ответа, то сохраняем сообщение у себя в истории, чтобы потом переотправить.
|
Если нет ответа, то сохраняем сообщение у себя в истории, чтобы потом переотправить.
|
||||||
`status==1` - доставлено, другой - недоставлено (помечаем как недоставлено
|
`status==1` - доставлено, другой - недоставлено (помечаем как недоставлено
|
||||||
@ -61,7 +70,9 @@ GUI - примитивная программа под Linux/Window/Android, к
|
|||||||
```json
|
```json
|
||||||
{ "action":"ping" }
|
{ "action":"ping" }
|
||||||
```
|
```
|
||||||
|
|
||||||
ответ:
|
ответ:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{ "action":"pong" }
|
{ "action":"pong" }
|
||||||
```
|
```
|
||||||
@ -72,10 +83,13 @@ GUI - примитивная программа под Linux/Window/Android, к
|
|||||||
```json
|
```json
|
||||||
{ "action": "history", "messages":[{},{},{}...] }
|
{ "action": "history", "messages":[{},{},{}...] }
|
||||||
```
|
```
|
||||||
|
|
||||||
ответ:
|
ответ:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{ "status":[1,1,1,0,1] }
|
{ "status":[1,1,1,0,1] }
|
||||||
```
|
```
|
||||||
|
|
||||||
В ответ приходит массив с 1 или 0. Если 1 - сообщение сохранено успешно, 0 - ошибка и его нужно потом переотправить.
|
В ответ приходит массив с 1 или 0. Если 1 - сообщение сохранено успешно, 0 - ошибка и его нужно потом переотправить.
|
||||||
|
|
||||||
### Отправление сообщения для другого абонента (это нужно чтобы отправлять тем, кто в offline)
|
### Отправление сообщения для другого абонента (это нужно чтобы отправлять тем, кто в offline)
|
||||||
@ -87,9 +101,12 @@ GUI - примитивная программа под Linux/Window/Android, к
|
|||||||
```json
|
```json
|
||||||
{ "action":"resend", ... }
|
{ "action":"resend", ... }
|
||||||
```
|
```
|
||||||
|
|
||||||
Параметры такие же как и для send
|
Параметры такие же как и для send
|
||||||
ответ
|
ответ
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{ "status":1 }
|
{ "status":1 }
|
||||||
```
|
```
|
||||||
Если `status == 0` - то эта нода не желает пересылать сообщения и ей повторно отправлять не нужно.
|
|
||||||
|
Если `status == 0` - то эта нода не желает пересылать сообщения и ей повторно отправлять не нужно.
|
Loading…
Reference in New Issue
Block a user