---
tags: Wiki
---
# Пример оформления описания API
Протокол: `http` `https`
Адрес: `my.is1c.ru/api/{название_метода}`

### Формирование подписи
Хэшируем алгоритмом sha256
Соль: `abc123`

### Обязательные GET параметры для всех запросов
* hash - хэш пользователя

## Пример описания GET запроса
==GET== `getRequest`

Здесь описание метода

**Параметры**
* user_id - id пользователя
* email
* signature

**Подпись**
* соль
* email

**Пример ответа**

{
    "ID":null,
    "name":"Doe",
    "first-name":"John",
    "age":25,
    "hobbies":[
        "reading",
        "cinema",
        {
            "sports":[
                "volley-ball",
                "badminton"
            ]
        }
    ],
    "address":{
    }
}

## Пример описания POST запрсоа
==POST== `postRequest`

Здесь описание метода

:::warning
Для этого метода обязательный GET параметр *hash* передавать не нужно
:::

**Параметры**
* user_id - id пользователя

**Тело запроса**

{
    "email": "[e-mail]",
    "name": "Ivan",
    "signature": "..."
}

**Подпись**
* соль
* name
* email

**Пример ответа**

{
    "error": false
}