Общие положения

  1. Используется архитектура RESTful, методы GET, PUT, POST, DELETE.
  2. Результаты команд возвращаются в формате JSON.
  3. API работает через протокол HTTPS.
  4. API обрабатывает запросы только с заголовком Content-Type: application/json. Только один запрос будет ждать другой тип данного заголовка (в описании запроса указано предупреждение об этом).
  5. Авторизация осуществляется посредством <JSON Web Token>, доступного в настройках API. Параметры заголовков для всех команд:
Authorization: bearer <JSON Web Token>
Host: api.umnico.com
  1. Не забывайте кодировать русские символы, передаваемые в URL запроса.
  2. Команды, возвращающие большие списки, поддерживают постраничный вывод с использованием:
  • либо параметра cursor (идентификатор или дата последнего элемента на предыдущей «странице») в URL или body,
  • либо параметра offset (integer - смещение относительно первой записи списка - по умолчанию 0) в URL.
  1. Команды, изменяющие объекты, могут изменять как сразу несколько полей, так и по одному (в этом случае передавать пустые поля не нужно).
  2. Формат возвращаемой ошибки (пример):
{
  errors: [
     "data.foo should be string",
     "data.bar should be <= 3"
  ]
}