Протокол общения между сервером и клиентом

HTTPS

Стиль построения API

REST

Используемая кодировка

UTF-8

Допустимые задержки

Генерация ответа на сервере в среднем занимает меньше 1 секунды.

Передача параметров

Параметры передаются в виде JSON-объекта в теле запроса. Для всех запросов должен быть выставлен Content-Type: application/json.

Перечисления

Перечисления в JSON-объектах передаются в виде типа String или Int соответственно.

Общий вид ответа сервера

Результат вызова любого метода представляет собоий JSON-объект следующей структуры:

Название поля

Тип поля

Название

Обязательность

{% for field in responseClass.fields -%} {%- include 'field-row.html.twig' with { field: field, objectsLinks: objectsLinks, useAnchors: useAnchors } %} {% endfor %}