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

Доступ

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

Токен доступа закрепляется за определенным пользователем определенной компании, а точнее - администратором компании, с помощью параметров интеграции API которого был произведен обмен ключа авторизации на токен. При обновлении токена доступа эта связка с администратором-владельцем остается.

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

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

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

Пример запроса* (новый клиент)
post /api/shared/v1/clients HTTP/1.1
Authorization
:
Bearer Pm7gdycNeHV_F1y4_tjWWIutC0Aq0gwl9wRnX-KBuHw
Content-Type
:
application/json; charset=utf-8
Host
:
api.pachca.com
Connection
:
close
User-Agent
:
Paw/3.1.10 (Macintosh; OS X/10.15.3) GCDHTTPRequest
Content-Length
:
219
{"client": {"full_name":"Glenn\u00a0M\u00a0Jackson","phones": ["404-550-6227"],"emails": ["john@example.com"],"address":"4447 Mount Olive Road","additional":"generated at fakeaddressgenerator","list_tags":["fake","fun"]}}

Обработка ответа метода 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":3609,"client_number":"00001","full_name":"Glenn M Jackson","phones":["404-550-6227"],"address":"4447 Mount Olive Road","emails":["john@example.com"],"additional":"generated at fakeaddressgenerator","user_id":226,"list_tags":[],"created_at":"2020-04-22T12:32:29.000Z"}}