Запросы и ответы

Доступ

Для работы с методами API вам необходимо иметь действующий access_token.

access_token не имеет времени жизни. Если вы используете access_token «Администратора» или «Владельца» пространства, то в разделе «Автоматизации» → «API» вы можете воспользоваться функцией сброса токена. В таком случае вы увидите новый Access token, а предыдущий станет недействительным.

Структура запроса метода API

При выполнении запроса, access_token необходимо поместить в заголовки (ключ Authorization с указанием типа Bearer), а в теле запроса указать все необходимые параметры метода. При этом не забудьте, что сервер ожидает перечисление параметров в формате JSON, кодировке UTF-8 и по протоколу HTTPS.

Обработка ответа метода API

Мы используем обычные коды ответов HTTP для обозначения результата выполнения запроса.

Ответ от сервера приходит в формате JSON и кодировке UTF-8.

При успешном ответе возвращаемый сервером результат будет представлен в теле ответа массивом data.

При ошибке выполнения запроса вы можете получить в теле ответа массив errors (подробнее об ошибках выполнения запросов вы можете прочитать в следующем разделе документации).