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:58:33 +03:00
parent 0ee36511c9
commit 20795f2194
1 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -42,7 +42,7 @@
### Тест подключения ### Тест подключения
```http request ```http
GET /api/v1/ping GET /api/v1/ping
``` ```
Проверить подключение к REST API. Проверить подключение к REST API.
@@ -56,7 +56,7 @@ GET /api/v1/ping
``` ```
### Проверить время сервера ### Проверить время сервера
```http request ```http
GET /api/v1/time GET /api/v1/time
``` ```
Проверить подключение к REST API и получить текущее время сервера. Проверить подключение к REST API и получить текущее время сервера.
@@ -233,7 +233,7 @@ deal:
Запрос: Запрос:
```http request ```http
POST /api/v1/deal POST /api/v1/deal
``` ```
@@ -308,10 +308,10 @@ gs96WVVRs4h9agBzKOM=
## Пользователь ## Пользователь
### Помощь ### Помощь
```http request ```http
GET /api/v1/help GET /api/v1/help
``` ```
```http request ```http
POST /api/v1/help POST /api/v1/help
``` ```
Получить справочную информацию по командам регистрации и обновления данных учётной записи. Получить справочную информацию по командам регистрации и обновления данных учётной записи.
@@ -322,7 +322,7 @@ POST /api/v1/help
**Пример:** **Пример:**
Запрос: Запрос:
```http request ```http
GET /api/v1/help?payload=html GET /api/v1/help?payload=html
``` ```
@@ -395,10 +395,10 @@ Templates:
###### Этот HTML-документ содержит инструкцию к составлению данных в виде `текста в произвольном формате`. ###### Этот HTML-документ содержит инструкцию к составлению данных в виде `текста в произвольном формате`.
### Статус ### Статус
```http request ```http
GET /api/v1/account/status GET /api/v1/account/status
``` ```
```http request ```http
POST /api/v1/account/status POST /api/v1/account/status
``` ```
Получить статус учётной записи пользователя. Получить статус учётной записи пользователя.
@@ -409,7 +409,7 @@ POST /api/v1/account/status
**Пример:** **Пример:**
Запрос: Запрос:
```http request ```http
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 request ```http
POST /api/v1/account/new POST /api/v1/account/new
``` ```
Зарегистрировать нового пользователя. Зарегистрировать нового пользователя.
@@ -437,7 +437,7 @@ POST /api/v1/account/new
[Тело запроса](#параметры-пользователя) [Тело запроса](#параметры-пользователя)
### Добавить ### Добавить
```http request ```http
POST /api/v1/account/add POST /api/v1/account/add
``` ```
Добавить данные в учётную запись пользователя. Добавить данные в учётную запись пользователя.
@@ -447,7 +447,7 @@ POST /api/v1/account/add
[Тело запроса](#параметры-пользователя) [Тело запроса](#параметры-пользователя)
### Обновить ### Обновить
```http request ```http
POST /api/v1/account/update POST /api/v1/account/update
``` ```
Обновить данные в учётной записи пользователя. Обновить данные в учётной записи пользователя.
@@ -457,7 +457,7 @@ POST /api/v1/account/update
[Тело запроса](#параметры-пользователя) [Тело запроса](#параметры-пользователя)
### Удалить ### Удалить
```http request ```http
POST /api/v1/account/delete POST /api/v1/account/delete
``` ```
Удалить учётную запись пользователя. Удалить учётную запись пользователя.
@@ -469,7 +469,7 @@ POST /api/v1/account/delete
## Сделка ## Сделка
### Создать ### Создать
```http request ```http
POST /api/v1/deal/create POST /api/v1/deal/create
``` ```
Создать сделку. Создать сделку.
@@ -479,7 +479,7 @@ POST /api/v1/deal/create
[Тело запроса](#параметры-сделки) [Тело запроса](#параметры-сделки)
### Оплатить ### Оплатить
```http request ```http
POST /api/v1/deal/pay POST /api/v1/deal/pay
``` ```
Оплатить сделку. Оплатить сделку.
@@ -489,7 +489,7 @@ POST /api/v1/deal/pay
[Тело запроса](#параметры-сделки) [Тело запроса](#параметры-сделки)
### Завершить ### Завершить
```http request ```http
POST /api/v1/deal/complete POST /api/v1/deal/complete
``` ```
Завершить сделку. Завершить сделку.
@@ -501,7 +501,7 @@ POST /api/v1/deal/complete
## Примеры: ## Примеры:
* **HTTP Request:** * **HTTP Request:**
```http request ```http
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 request ```http
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" \
* **curl command:** * **curl command:**
```curl ```curl
```http request curl "http://localhost:4999/api/v1/account/new?payload=html" \
-X POST \ -X POST \
-d "mynFyJJkRhsbB6y1Q5kTgDGckVz2m9NKH8\n02ef68c191984433c8a730b8fa48a47ec016a0727e6d26cc0982c8900b39354f61" \ -d "mynFyJJkRhsbB6y1Q5kTgDGckVz2m9NKH8\n02ef68c191984433c8a730b8fa48a47ec016a0727e6d26cc0982c8900b39354f61" \
-H "Content-Type: text/plain" -H "Content-Type: text/plain"