Общие положения¶
- Используется архитектура RESTful, методы GET, PUT и POST.
- Результаты команд возвращаются в формате JSON.
- API работает через протокол HTTPS.
- Авторизация осуществляется посредством <JSON Web Token>, доступного в настройках API. Параметры для всех команд:
Authorization: bearer <JSON Web Token>
Host: api.umnico.com
- Не забывайте кодировать русские символы, передаваемые в URL запроса.
- Команды, возвращающие большие списки, поддерживают постраничный вывод с использованием:
- либо параметра
cursor
(идентификатор или дата последнего элемента на предыдущей «странице») в URL или body,- либо параметра
offset
(integer - смещение относительно первой записи списка - по умолчанию 0) в URL.
- Команды, изменяющие объекты, могут изменять как сразу несколько полей, так и по одному (в этом случае передавать пустые поля не нужно).