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

Доступ

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

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

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

Работа с API возможна через чат-ботов. Список доступных методов вы можете прочитать тут.

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

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

post /api/shared/v1/users HTTP/1.1

{"user":{"first_name":"Олег","last_name":"Петров","email":"olegp@example.com","department":"Продукт","list_tags":["Product","Design"],"custom_properties":[{"id":1678,"value":"Санкт-Петербург"}]},"skip_email_notify":true}

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

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

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

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

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

HTTP/1.1 201 Created

Server: nginx/1.14.2
Date: Wed, 22 Apr 2020 12:32:29 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: close
ETag: W/"4d63aae1430a3bbd35e95e3db6b364df"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 12f8a05c-c5cf-4a79-8d2f-f82cc477c410
X-Runtime: 0.117503
Vary: Origin
X-Rack-CORS: miss; no-origin

{"data":{"id":12,"first_name":"Олег","last_name":"Петров","nickname":"","email":"olegp@example.com","phone_number":"","department":"Продукт","role":"admin","suspended":false,"invite_status":"confirmed","list_tags":["Product","Design"],"custom_properties":[{"id":1678,"name":"Город","data_type":"string","value":"Санкт-Петербург"}]}}