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

Доступ

Для работы с методами API вам необходимо иметь действующий Access token . Получить его вы можете в интерфейсе продукта, в разделе «Автоматизации» → «API» (данный раздел доступен только пользователям с ролью «Администратор»).

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

Токен доступа закрепляется за определенным пользователем определенной компании, а точнее - администратором компании, Access token которого используется.

Это значит, что все вызываемые методы API будут выполняться от имени администратора-владельца и в соответствии с правами доступа администратора в компании (подробнее о правах доступа вы можете прочитать в профиле вашей компании).

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

При выполнении запроса Access Token необходимо поместить в заголовки (ключ Authorization с указанием типа Bearer), а в теле запроса указать все необходимые параметры метода. При этом не забудьте, что сервер ожидает перечисление параметров в формате JSON , кодировке UTF-8 , на базовый адрес api.pachca.com/api/shared/v1 (с указанием метода) и по протоколу HTTPS .

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

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

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

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

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