private/apostol-dm
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Committing updates.

Browse Source
This commit is contained in:
Преподобный Ален
2022-07-01 14:57:16 +03:00
parent 91e6b9b938
commit 0ee36511c9
1 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
doc/REST-API-ru.md
View File

@@ -233,9 +233,9 @@ deal:
Запрос: Запрос:
~~~http request ```http request
POST /api/v1/deal POST /api/v1/deal
~~~ ```
Тело запроса Тело запроса
```json ```json
@@ -259,7 +259,7 @@ POST /api/v1/deal
Ответ: Ответ:
~~~json ```json
{ {
"id": "AEEAB-PEE95-O6F30-S68A8-TC55A-O3B7D-L98370", "id": "AEEAB-PEE95-O6F30-S68A8-TC55A-O3B7D-L98370",
"action": "Created", "action": "Created",
@@ -269,11 +269,11 @@ POST /api/v1/deal
}, },
"payload": "LS0tLS1CRUdJTiBQR1AgU0lHTkVEIE1FU1NBR0UtLS0tLQpIYXNoOiBTSEE1MTIKCmRlYWw6CiAgb3JkZXI6IENyZWF0ZWQKICB0eXBlOiBQcmVwYWlkCiAgYXQ6IGh0dHA6Ly9wbGFjYXJkLnpyLWNvZGUuY29tCiAgZGF0ZTogMjAyMi0wNC0xMSAxMToxNDo0NiBVVEMKICBzZWxsZXI6CiAgICBhZGRyZXNzOiBuMmYzY2JlVVVGaGJ6Nm1GTHBEVXpNbnJ0NzJzUHU3V1FLCiAgICByYXRpbmc6IDAsIDAlCiAgY3VzdG9tZXI6CiAgICBhZGRyZXNzOiAyTjNvZWZWZWc2c3RpVGI1S2gzb3pDU2thcW14OTFGRGJzbQogICAgcmF0aW5nOiAwLCAwJQogIHBheW1lbnQ6CiAgICB1bnRpbDogMjAyMi0wNC0xMiAxMToxNDo0NiBVVEMKICAgIGFkZHJlc3M6IDJONmFidjNxaGdIUXh2bnRmRHptbWk0a0htMTRUYWRvQnB1CiAgICBzdW06IDAuMDAwMDEgdEJUQwogIGZlZWRiYWNrOgogICAgbGVhdmUtYmVmb3JlOiAyMDIyLTA0LTEyIDExOjE0OjQ2IFVUQwotLS0tLUJFR0lOIFBHUCBTSUdOQVRVUkUtLS0tLQpWZXJzaW9uOiBjYwoKd3B3RUFRRUtBQVlGQW1KVURid0FDZ2tRN0lqUjIwSkJpemVCckFRQWp0UlU5R3IySm1qdUhLTHhaejQrVWMzQwp2cUFzem1JcjhZRUdRUWZKS3o3SjJsd1U0ZkNOaVByZ29yQTdIdVRGa1Bqd0JrN0N0MHBOZlQwWmpxYTVYWXk5Cml1d01hRkVsM1dmVUQ0MlQxQVFWUDhCbUp6RmtxUXdVSE81dWtDS1RpaTViK3VHVVIvZzJETStFOXVBb3ZYWEYKZ3M5NldWVlJzNGg5YWdCektPTT0KPW4razcKLS0tLS1FTkQgUEdQIFNJR05BVFVSRS0tLS0t" "payload": "LS0tLS1CRUdJTiBQR1AgU0lHTkVEIE1FU1NBR0UtLS0tLQpIYXNoOiBTSEE1MTIKCmRlYWw6CiAgb3JkZXI6IENyZWF0ZWQKICB0eXBlOiBQcmVwYWlkCiAgYXQ6IGh0dHA6Ly9wbGFjYXJkLnpyLWNvZGUuY29tCiAgZGF0ZTogMjAyMi0wNC0xMSAxMToxNDo0NiBVVEMKICBzZWxsZXI6CiAgICBhZGRyZXNzOiBuMmYzY2JlVVVGaGJ6Nm1GTHBEVXpNbnJ0NzJzUHU3V1FLCiAgICByYXRpbmc6IDAsIDAlCiAgY3VzdG9tZXI6CiAgICBhZGRyZXNzOiAyTjNvZWZWZWc2c3RpVGI1S2gzb3pDU2thcW14OTFGRGJzbQogICAgcmF0aW5nOiAwLCAwJQogIHBheW1lbnQ6CiAgICB1bnRpbDogMjAyMi0wNC0xMiAxMToxNDo0NiBVVEMKICAgIGFkZHJlc3M6IDJONmFidjNxaGdIUXh2bnRmRHptbWk0a0htMTRUYWRvQnB1CiAgICBzdW06IDAuMDAwMDEgdEJUQwogIGZlZWRiYWNrOgogICAgbGVhdmUtYmVmb3JlOiAyMDIyLTA0LTEyIDExOjE0OjQ2IFVUQwotLS0tLUJFR0lOIFBHUCBTSUdOQVRVUkUtLS0tLQpWZXJzaW9uOiBjYwoKd3B3RUFRRUtBQVlGQW1KVURid0FDZ2tRN0lqUjIwSkJpemVCckFRQWp0UlU5R3IySm1qdUhLTHhaejQrVWMzQwp2cUFzem1JcjhZRUdRUWZKS3o3SjJsd1U0ZkNOaVByZ29yQTdIdVRGa1Bqd0JrN0N0MHBOZlQwWmpxYTVYWXk5Cml1d01hRkVsM1dmVUQ0MlQxQVFWUDhCbUp6RmtxUXdVSE81dWtDS1RpaTViK3VHVVIvZzJETStFOXVBb3ZYWEYKZ3M5NldWVlJzNGg5YWdCektPTT0KPW4razcKLS0tLS1FTkQgUEdQIFNJR05BVFVSRS0tLS0t"
} }
~~~ ```
Расшифровка `payload`: Расшифровка `payload`:
~~~yaml ```yaml
-----BEGIN PGP SIGNED MESSAGE----- -----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512 Hash: SHA512
@@ -303,15 +303,15 @@ iuwMaFEl3WfUD42T1AQVP8BmJzFkqQwUHO5ukCKTii5b+uGUR/g2DM+E9uAovXXF
gs96WVVRs4h9agBzKOM= gs96WVVRs4h9agBzKOM=
=n+k7 =n+k7
-----END PGP SIGNATURE----- -----END PGP SIGNATURE-----
~~~ ```
## Пользователь ## Пользователь
### Помощь ### Помощь
```http ```http request
GET /api/v1/help GET /api/v1/help
``` ```
```http ```http request
POST /api/v1/help POST /api/v1/help
``` ```
Получить справочную информацию по командам регистрации и обновления данных учётной записи. Получить справочную информацию по командам регистрации и обновления данных учётной записи.
@@ -322,7 +322,7 @@ POST /api/v1/help
**Пример:** **Пример:**
Запрос: Запрос:
```http ```http request
GET /api/v1/help?payload=html GET /api/v1/help?payload=html
``` ```
@@ -395,10 +395,10 @@ Templates:
###### Этот HTML-документ содержит инструкцию к составлению данных в виде `текста в произвольном формате`. ###### Этот HTML-документ содержит инструкцию к составлению данных в виде `текста в произвольном формате`.
### Статус ### Статус
```http ```http request
GET /api/v1/account/status GET /api/v1/account/status
``` ```
```http ```http request
POST /api/v1/account/status POST /api/v1/account/status
``` ```
Получить статус учётной записи пользователя. Получить статус учётной записи пользователя.
@@ -409,7 +409,7 @@ POST /api/v1/account/status
**Пример:** **Пример:**
Запрос: Запрос:
```http ```http request
GET /api/v1/account/status?address=null GET /api/v1/account/status?address=null
``` ```
@@ -427,7 +427,7 @@ GET /api/v1/account/status?address=null
``` ```
### Новый ### Новый
```http ```http request
POST /api/v1/account/new POST /api/v1/account/new
``` ```
Зарегистрировать нового пользователя. Зарегистрировать нового пользователя.
@@ -437,7 +437,7 @@ POST /api/v1/account/new
[Тело запроса](#параметры-пользователя) [Тело запроса](#параметры-пользователя)
### Добавить ### Добавить
```http ```http request
POST /api/v1/account/add POST /api/v1/account/add
``` ```
Добавить данные в учётную запись пользователя. Добавить данные в учётную запись пользователя.
@@ -447,7 +447,7 @@ POST /api/v1/account/add
[Тело запроса](#параметры-пользователя) [Тело запроса](#параметры-пользователя)
### Обновить ### Обновить
```http ```http request
POST /api/v1/account/update POST /api/v1/account/update
``` ```
Обновить данные в учётной записи пользователя. Обновить данные в учётной записи пользователя.
@@ -457,7 +457,7 @@ POST /api/v1/account/update
[Тело запроса](#параметры-пользователя) [Тело запроса](#параметры-пользователя)
### Удалить ### Удалить
```http ```http request
POST /api/v1/account/delete POST /api/v1/account/delete
``` ```
Удалить учётную запись пользователя. Удалить учётную запись пользователя.
@@ -469,7 +469,7 @@ POST /api/v1/account/delete
## Сделка ## Сделка
### Создать ### Создать
```http ```http request
POST /api/v1/deal/create POST /api/v1/deal/create
``` ```
Создать сделку. Создать сделку.
@@ -479,7 +479,7 @@ POST /api/v1/deal/create
[Тело запроса](#параметры-сделки) [Тело запроса](#параметры-сделки)
### Оплатить ### Оплатить
```http ```http request
POST /api/v1/deal/pay POST /api/v1/deal/pay
``` ```
Оплатить сделку. Оплатить сделку.
@@ -489,7 +489,7 @@ POST /api/v1/deal/pay
[Тело запроса](#параметры-сделки) [Тело запроса](#параметры-сделки)
### Завершить ### Завершить
```http ```http request
POST /api/v1/deal/complete POST /api/v1/deal/complete
``` ```
Завершить сделку. Завершить сделку.
@@ -501,7 +501,7 @@ POST /api/v1/deal/complete
## Примеры: ## Примеры:
* **HTTP Request:** * **HTTP Request:**
```http ```http request
POST /api/v1/account/new HTTP/1.1 POST /api/v1/account/new HTTP/1.1
Host: localhost:4999 Host: localhost:4999
Content-Type: application/x-www-form-urlencoded Content-Type: application/x-www-form-urlencoded
@@ -518,7 +518,7 @@ curl "http://localhost:4999/api/v1/account/new?payload=html" \
``` ```
* **HTTP Request:** * **HTTP Request:**
```http ```http request
POST /api/v1/account/new HTTP/1.1 POST /api/v1/account/new HTTP/1.1
Host: localhost:4999 Host: localhost:4999
Content-Type: application/json Content-Type: application/json
@@ -535,7 +535,7 @@ curl "http://localhost:4999/api/v1/account/new?payload=html" \
``` ```
* **HTTP Request:** * **HTTP Request:**
```http ```http request
POST /api/v1/account/new?payload=html HTTP/1.1 POST /api/v1/account/new?payload=html HTTP/1.1
Host: localhost:4999 Host: localhost:4999
Content-Type: text/plain Content-Type: text/plain