Структура запросов
Последнее обновление 19.05.2023
Параметры
Каждый запрос к API должен сопровождаться следующими HTTP-параметрами:
| Наименование | Описание | Значение |
|---|---|---|
| Host | Адрес узла API | - |
| User-Agent | Характеристика пользовательского агента | okhttp/4.9.0 |
| Accept-Encoding | Алгоритм сжатия | gzip |
| Connection | Тип соединения | Keep-Alive |
| X-Forwarded-For | Адрес исходящего запроса | - |
| Content-Length | Длина контента | - |
| Authorization | Basic-токен | Basic \<токен> |
| Content-Type POST/PUT | Тип контента | application/json; charset=utf-8 |
Тело запроса
Тело запроса содержит информацию, необходимую для создания или изменения объекта.
Информация должна передаваться в формате JSON. С описанием возможных полей и структурой тела вы можете познакомиться в разделах, посвященных запросам к API.
Пример
POST|GET|PUT|DELETE http://<api>/<resources>/<resource_id>/?<param1>=<value1>&<param2>=<value2> HTTP/1.1
Host: <api>
User-Agent: okhttp/4.9.0
Accept-Encoding: gzip
Connection: Keep-Alive
X-Forwarded-For:
Content-Length:
Authorization: Basic <token>
Content-Type: application/json; charset=UTF-8
...
{json-object | json-array}