Методы
Все методы API доступны только по защищенному https-каналу.
В облачном Pyrus получить адрес, по которому расположены методы API, можно с помощью запроса авторизации, см. api_url и files_url. Обратите внимание, что в примерах в нашей справке используется адрес https://api.pyrus.com/.
Обратите внимание: если вы работаете на серверной версии Pyrus — Pyrus Datacenter — все методы API будут размещаться по адресу вида pyrus.yourdomain.org/api, где pyrus.yourdomain.org — ваш корпоративный адрес, по которому развернут Pyrus Datacenter. Соответственно, в API-запросах используйте ссылку pyrus.yourdomain.org/api.
В каждом запросе к API должен быть указан HTTP заголовок Authorization:
Authorization: Bearer access_token.
Как получить access_token, описано в разделе Авторизация.
Формат передачи данных
Параметры GET запросов передаются в URL, и в случае наличия специальных символов должны быть экранированы с помощью urlencode.
Параметры POST запросов и все ответы сервера передаются в формате JSON.
Даты передаются в формате ISO 8601. Ответ от сервера всегда приходит с нулевой временной зоной.
При передаче чисел в качестве разделителя целой и дробной части используется точка.
Пустые поля в ответе не возвращаются.
В случае ошибочного вызова возвращается наиболее подходящий HTTP Status Code. Также в случае ошибки предоставляется дополнительная информация, включающая поля error — сообщение об ошибке и error_code — код ошибки.
В разделе Ошибки и ограничения вы найдете описание наиболее распространенных ошибок.