Модуль "Ammina. Партнерский REST 1С-Битрикс" предоставляет программный и административный интерфейс для обращения к партнерскому REST (https://dev.1c-bitrix.ru/learning/course/?COURSE_ID=133&INDEX=Y).
Программный интерфейс модуля
Позволяет вызвать REST метод как обычный метод объекта. В качестве ответа сервера будет доступен объект, поля которого будут соответствовать полям ответа.
Например, получение информации о лицензионном ключе:
CModule::IncludeModule("ammina.backup");
$oClient = \Ammina\BitrixRest\Client::getInstance();
$oAnswer = $oClient->callMethodKeyInfo("XXX", true);
, где XXX- лицензионный ключ для проверки. Второй параметр указывает использовать ли штатное кеширование либо отключить его.
$oAnswer будет являться объектом класса Ammina\BitrixRest\Answer\KeyInfo, который содержит следующие поля:
class KeyInfo extends BaseAnswer
{
public $licenseCode;
public $licenseName;
public $client;
public $clientEmail;
public $siteUrl;
public $dateFrom;
public $dateFromTimeStamp;
public $dateTo;
public $dateToTimeStamp;
public $maxSites;
public $maxUsers;
}
Также программный интерфейс модуля позволяет обрабатывать Callback как события на сайте с установленным модулем.
Пример подключения обработчика событий на Callback, добавленный методом add.callback.add.coupon.
\Bitrix\Main\EventManager::getInstance()->addEventHandler("ammina.bitrixrest", "OnAddCoupon", "OnAddCoupon");
function OnAddCoupon(\Bitrix\Main\Event $event)
{
}
Доступны следующие типы событий:
OnActivateCoupon
OnAddBitrix24PartnerPortal
OnAddCoupon
OnB24mpActivateCoupon
OnB24mpAddCoupon
OnBitrix24PortalBecomeActive
OnBitrix24PortalChangeTariff
OnUnknown
Административный интерфейс модуля
Административный интерфейс позволяет выполнить запрос к партнерскому REST без добавления программного кода.
Административный интерфейс располагается по пути "Настройки -> Ammina BitrixREST: Партнерский REST 1С-Битрикс -> Выполнить Rest запрос".
Для этого выберите метод, укажите обязательные параметры, способ вывода данных и нажмите кнопку "Выполнить"
Модуль предназначен для партнеров 1С-Битрикс.
