Инфоблоки тема 18 из 27

Запись в инфоблок через API

Инфоблок может принимать данные с сайта: отзывы, заявки, обращения. Запись по умолчанию выключена: пока администратор её не включил, методов записи у инфоблока нет.

в этой теме 6
  1. Как включить запись в инфоблок
  2. Создание: POST
  3. Изменение и удаление: PUT, DELETE
  4. Отказы
  5. Модерация
  6. Что почитать после записи в инфоблок

Как включить запись в инфоблок

Настройки модуля -> вкладка «Инфоблоки» -> инфоблок слева -> таб «Запись».

Таб «Запись»
НастройкаЧто значит
Кто создаётНикто (по умолчанию) / Авторизованные / Все, включая гостей
Изменение, УдалениеЗапрещено / Только своё (только автор элемента)
Кто видитВсе элементы / Только свои (см. Личные данные)
Новые элементыСразу активны / На модерации (неактивны, пока администратор не включит)
Капча для гостейГость передаёт токен reCAPTCHA в поле captchaToken
Лимит создания с IP в часСколько элементов гость создаёт с одного адреса за час; 0 — без лимита
Принимаемые данныеЧипами: поля элемента и свойства инфоблока

Принимаются только отмеченные чипами поля и свойства, остальное игнорируется (например, гость не может передать previewText, если он не выбран). Чипы свойств меняют штатный флаг свойства «Принимать в POST запросах через BIK.REST API». Поля элемента: название, символьный код, анонс, детальный текст, картинки анонса и детальная, раздел, даты активности.

Методы появляются сами: создание — если создавать может хоть кто-то, изменение и удаление — при «Только своё». После сохранения настроек кеш сбрасывается, в документации API инфоблока появляются методы с примером запроса, собранным из ваших чипов.

Создание: POST

Допустим, у инфоблока «Заявки» с кодом API requests создание разрешено всем, принимаются «Название» и свойство «Телефон» (код PHONE). Ключи тела — camelCase: поле name, свойство phone.

bash
curl -i -X POST "https://example.ru/api/iblock/requests/elements" \
  -H "Content-Type: application/json" \
  -d '{"name": "Перезвоните мне", "phone": "+7 900 000-00-00", "captchaToken": "..."}'
ответ
HTTP/1.1 200 OK
X-Session-Id: JLfAjGOFZ3qb2elyU2VIxlhvt1kYjQMZ
json
{
    "data": { "id": 501 },
    "success": true
}

Метод начинает сессию: ID приходит в заголовке X-Session-Id (см. Сессия и авторизация). Тело — JSON или форма; файлы свойств и картинки — multipart/form-data. Если Битрикс отказал в сохранении, текст попадает в errors со статусом 200.

Изменение и удаление: PUT, DELETE

Только автор элемента и только если разрешено «Только своё». Передаются только изменяемые поля:

bash
curl -X PUT "https://example.ru/api/iblock/requests/elements/501" \
  -H "Content-Type: application/json" -H "X-Session-Id: JLfAjGOFZ3qb2elyU2VIxlhvt1kYjQMZ" \
  -d '{"name": "Перезвоните после 18:00"}'

curl -X DELETE "https://example.ru/api/iblock/requests/elements/501" \
  -H "X-Session-Id: JLfAjGOFZ3qb2elyU2VIxlhvt1kYjQMZ"

Успех — {"success": true}.

Отказы

Каждый отказ объясняется текстом в поле error:

СтатусТекстКогда
401Войдите, чтобы отправитьсоздавать могут только авторизованные; или гость меняет или удаляет
400Подтвердите, что вы не роботвключена капча, токена нет или он неверный
429Слишком много отправок, попробуйте позжегость превысил лимит с адреса
403Изменять можно только свои записивошёл не автор элемента
404Не найденозапись в инфоблок выключена (метода нет)
json
{
    "success": false,
    "error": "Слишком много отправок, попробуйте позже"
}

Гость не может изменить или удалить ни один элемент. Нужен сторонний вывод ответа (например, сообщение «Спасибо») — используйте событие OnAfterIblockPostElements.

Модерация

При «Новые элементы: На модерации» созданный элемент неактивен и не виден в списке, пока администратор его не активирует. Автор видит его через own=Y.

Что почитать после записи в инфоблок

Подключим BIK.REST-API к вашему сайту

Оставьте заявку — установим и настроим модуль, ответим на вопросы по API.

c заботой о вас, мы используем cookie на своем сайте, чтобы интернет был чистым и прекрасным