ChronosXYZ/Influence-cjdns
1
0
Fork 0
mirror of https://github.com/ChronosX88/Influence-cjdns.git synced 2024-11-23 15:42:18 +00:00
Code Issues Projects Releases Wiki Activity

Update API.md

Browse Source
This commit is contained in:
ChronosX88 2018-05-09 14:54:44 +03:00 committed by GitHub
parent 178b72c1a6
commit 70d2b7292f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
API.md
View File

@ -13,7 +13,7 @@ GUI - примитивная программа под Linux/Window/Android, к
На сервере также хранится история переписки. На сервере также хранится история переписки.
У сервера есть список контактов (друзей), в формате: У сервера есть список контактов (друзей), в формате:
``` ```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:... }
... ...
@ -29,21 +29,21 @@ GUI - примитивная программа под Linux/Window/Android, к
1. Добавление в друзья 1. Добавление в друзья
Используется, чтобы установить связь с контактом. Для этого запрашиваем у него ключ доступа, предварительно отправив свой. Используется, чтобы установить связь с контактом. Для этого запрашиваем у него ключ доступа, предварительно отправив свой.
``` ```json
{ action: "handshake", key: "пароль" } { action: "handshake", key: "пароль" }
``` ```
ответ ответ
``` ```json
{ status: 1 } { status: 1 }
``` ```
Когда один отправил запрос - то второй может отправить свой ключ и тогда сервера смогут общаться друг с другом. Когда один отправил запрос - то второй может отправить свой ключ и тогда сервера смогут общаться друг с другом.
2. Отправка сообщения: 2. Отправка сообщения:
``` ```json
{ action:"send", from: "адрес", to: "адрес", message: "сообщение", timestamp: "время", enctype: "", key: "" } { action:"send", from: "адрес", to: "адрес", message: "сообщение", timestamp: "время", enctype: "", key: "" }
``` ```
ответ: ответ:
``` ```json
{ status: 1 } { status: 1 }
``` ```
Сообщение может быть зашифровано, метод шифрования в поле enctype. Сообщение может быть зашифровано, метод шифрования в поле enctype.
@ -52,21 +52,21 @@ GUI - примитивная программа под Linux/Window/Android, к
3. Пинг - проверка онлайн 3. Пинг - проверка онлайн
Если прошло время больше чем last_connect + 1 минута, от отправляем запрос Если прошло время больше чем last_connect + 1 минута, от отправляем запрос
``` ```json
{ action: "ping" } { action: "ping" }
``` ```
ответ: ответ:
``` ```json
{ action: "pong" } { action: "pong" }
``` ```
4. Если у нас есть сообщения для адреса и он онлайн (last_connect < 1 минуты), то передаём их 4. Если у нас есть сообщения для адреса и он онлайн (last_connect < 1 минуты), то передаём их
Если для этого адрес в базе есть недоставленные сообщения, то отправляем такой запрос: Если для этого адрес в базе есть недоставленные сообщения, то отправляем такой запрос:
``` ```json
{ action: "history", messages:[{},{},{}...] } { action: "history", messages:[{},{},{}...] }
``` ```
ответ ответ
``` ```json
{ status:[1,1,1,0,1] } { status:[1,1,1,0,1] }
``` ```
В ответ приходит массив с 1 или 0. Если 1 - сообщение сохранено успешно, 0 - ошибка и его нужно потом переотправить. В ответ приходит массив с 1 или 0. Если 1 - сообщение сохранено успешно, 0 - ошибка и его нужно потом переотправить.
@ -75,12 +75,12 @@ GUI - примитивная программа под Linux/Window/Android, к
Если человек, которому мы отправляем сообщение offline - то во-первых оно сохраняется у себя на сервере, для последующей отправки. Если человек, которому мы отправляем сообщение offline - то во-первых оно сохраняется у себя на сервере, для последующей отправки.
Во-вторых, можно попросить какого-то друга его переотправить. Для этого выбираем случайно несколько друзей из списка контактов, у которых can_resend == 1 и отправляем им запрос. Во-вторых, можно попросить какого-то друга его переотправить. Для этого выбираем случайно несколько друзей из списка контактов, у которых can_resend == 1 и отправляем им запрос.
Для ретрансляции можно также использовать свой сервер в интернете, нужно просто его добавить в контакты. Для ретрансляции можно также использовать свой сервер в интернете, нужно просто его добавить в контакты.
``` ```json
{ action: "resend", ... } { action: "resend", ... }
``` ```
Параметры такие же как и для send Параметры такие же как и для send
ответ ответ
``` ```json
{ status: 1 } { status: 1 }
``` ```
Если status: 0 - то эта нода не желает пересылать сообщения и ей повторно отправлять не нужно. Если status: 0 - то эта нода не желает пересылать сообщения и ей повторно отправлять не нужно.