Как использовать метод SDK entity.add в Битрикс24

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Как использовать метод SDK entity.add в Битрикс24», проанализируем лучшие практики и покажем, как правильно использовать entity.add в реальных задачах.

Описание метода SDK entity.add

Метод entity.add является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. Create Data Storage

Параметры и сигнатура метода

В рамках SDK метод объявлен в пространстве имен \Bitrix24\SDK\Services\Entity\Entity\Service\Entity со следующей сигнатурой:

public function add(
      string $entity,
      string $name,
      array $access
  ): Result

Пример использования на PHP

Ниже представлен готовый практический пример интеграции с использованием Bitrix24 PHP SDK. Этот пример показывает, как правильно инициализировать сервис-билдер и вызвать метод add:

<?php
declare(strict_types=1);

use Bitrix24\SDK\Services\ServiceBuilderFactory;

// Инициализация официального Bitrix24 PHP SDK через входящий вебхук
$webhookUrl = 'https://your-portal.bitrix24.ru/rest/1/your-webhook-code/';
$serviceBuilder = ServiceBuilderFactory::createServiceBuilderFromWebhook($webhookUrl);

try {
    // Подготовка параметров для вызова метода entity.add
    $entity = "пример_значения";
    $name = "пример_значения";
    $access = [];

    // Выполнение запроса через Scope getEntityScope и сервис entity
    $result = $serviceBuilder->getEntityScope()->entity()->add(
          $entity,
          $name,
          $access
      );

    // Обработка полученных данных
    print_r($result->getResponseData()->getResult());

} catch (\Throwable $exception) {
    // Обработка исключений при интеграции
    echo "Ошибка при выполнении метода entity.add: " . $exception->getMessage();
}

Полезные ссылки

• Официальная REST API документация: https://apidocs.bitrix24.com/api-reference/entity/entities/entity-add.html
• Репозиторий PHP SDK на GitHub: bitrix24-php-sdk