НАЧАЛО >> Битрикс24 >> Endpoint и формат обмена📄 Скачать в DOCX
JSON-RPC сервер модуля доступен через входную точку:
POST /JSONRPC.php?i128Module=Bitrix24Тело запроса должно быть JSON-RPC 2.0 объектом или массивом объектов для
batch-вызова. Для обычного вызова указываются поля jsonrpc, method,
params и id.
{
"jsonrpc": "2.0",
"method": "GetUser",
"params": {
"user_id": "reader-001"
},
"id": 1
}Ответ содержит result при успешном выполнении или error при ошибке.
{
"jsonrpc": "2.0",
"result": {},
"id": 1
}| Правило | Описание |
|---|---|
| Метод HTTP | Сервер принимает только POST для обычных JSON-RPC вызовов. |
| Тип тела | JSON-объект JSON-RPC 2.0 или массив объектов для batch-вызова. |
| Идентификатор | Если поле id не передано, вызов считается notification и ответ не возвращается. |
| Параметры | params можно передавать позиционным массивом или объектом с именованными параметрами. |
| Именованные параметры | При объекте params значения сопоставляются с именами параметров PHP-метода. |
| Batch | Если тело запроса - массив, сервер выполнит каждый вызов и вернет массив ответов. |
| SMD | Запрос с параметром smd возвращает service map, построенный по публичным методам сервера. |
| Код | Значение |
|---|---|
-32700 |
Ошибка разбора JSON. |
-32600 |
Некорректный запрос: например, не POST, нет jsonrpc: "2.0" или тело пустое. |
-32601 |
Метод не найден или метод скрыт сервером. |
-32602 |
Некорректные параметры: не хватает обязательного параметра или params имеет неподдерживаемый тип. |
-32603 |
Внутренняя ошибка. |
Ошибки бизнес-операций возвращаются тем модулем, который выполняет операцию:
Users, RQST, Bookland, EC или Database. Например, заказ не будет
создан, если не найдена запись пользователя, БД каталога не открылась или
шифр записи не найден.
Входная точка проходит через обычный запуск ИРБИС 128. Конкретные правила доступа зависят от настроек сайта, авторизации, сессии, веб-сервера и интеграционного контура. Внешнему клиенту нужно использовать тот URL и способ доступа, который выдан администратором системы.