Для работы с основными методами API вам необходимо иметь действующий
Access token
. Всю информация по получению токена доступа и о его обновлении вы можете найти в разделе Авторизация и получение токена.
Токен доступа закрепляется за определенным пользователем определенной компании, а точнее - администратором компании, с помощью параметров интеграции API которого был произведен обмен ключа авторизации на токен. При обновлении токена доступа эта связка с администратором-владельцем остается.
Это значит, что все вызываемые методы API будут выполняться от имени администратора-владельца и в соответствии с правами доступа администратора в компании (подробнее о правах доступа вы можете прочитать в профиле вашей компании).
При выполнении запроса
Access Token
необходимо поместить в заголовки (ключ Authorization с указанием типа Bearer), а в теле запроса указать все необходимые параметры метода. При этом не забудьте, что сервер ожидает перечисление параметров в формате
JSON
, кодировке
UTF-8
, на базовый адрес
api.pachca.com/api/shared/v1
(с указанием метода) и по протоколу
HTTPS
.
Мы используем обычные коды ответов HTTP для обозначения результата выполнения запроса.
Ответ от сервера приходит в формате
JSON
и кодировке
UTF-8
.
При успешном ответе возвращаемый сервером результат будет представлен в теле ответа массивом
data
.
При ошибке выполнения запроса вы можете получить в теле ответа массив
errors
(подробнее об ошибках выполнения запросов вы можете прочитать в следующем разделе документации).