АРАМА: Рест-апи на 1С-Битрикс. Бэкенд мобильных приложений. Конструктор запросов

Установка и настройка модуля

Данный курс описывает модуль АРАМА: Rest API на 1 С-Битрикс. Бэкенд мобильных приложений, предназначенный для сайтов на базе cms 1С-Битрикс.

Rest API для БУС — это инструмент для разработчиков (программистов), предоставляет АПИ для взаимодействия с веб-сайтом: запросом, добавлением, редактированием информации в нём.

Для кого этот курс?

Данный курс служит для более полного ознакомления с модулем и адресован тем, кто разрабатывает разного рода внешние приложения и в качестве бэкенда использует веб-сайт. Иными словами инструмент незаменим для широкого спектра специалистов:

  • разработчиков мобильных приложений;
  • специалистов 1С;
  • разработчиков веб и иных приложений.

Модуль значительно упрощает жизнь и позволяет избавиться от ряда рутинных задач в ходе разработок.

Примечание: На курсе рассмотрены: принцип работы модуля, особенности, преимущества, наиболее яркие примеры использования. Приведены материалы, позволяющие расширить стандартные возможности решения.

Модуль устанавливается стандартно, подробно об этом написано на сайте 1С-Битрикс -  установка модулей.

После установки модуля АРАМА: Rest API на 1 С-Битрикс. Бэкенд мобильных приложений в дереве визуального редактора (Scoder - Rest API - Rest API для БУС) должен появится компонент - Rest API для БУС. Если у вас такого нет, то обновите кэш визуального редактора.

Параметры компонента:

  • Проверять АПИ ключ - не обязательный параметр. Используется если нужно обезопасить свое приложение, чтобы модуль отвечал только при совпадении АПИ ключа.
  • АПИ ключ - уникальный код, служит для проверки с ключом из внешнего источника, если не совпадает то вернет ошибку.
  • АПИ ключ с внешнего источника - в данный параметр необходимо указать код, который приходит из внешнего источника (приложения), должен совпадать с АПИ ключом, иначе модуль будет считать, что приложение не знакомо и вернет ошибку.
  • Включить поддержку ЧПУ - стандартный параметр для комплексного компонента, используется для включения/отключения режима ЧПУ компонента. Обязательно включить.
  • Каталог ЧПУ (относительно корня сайта) - стандартный параметр для комплексного компонента, рекомендуем оставить как есть, если включили поддержку ЧПУ.
  • Страница методов - стандартный параметр для комплексного компонента, рекомендуем оставить как есть, если включили поддержку ЧПУ.

Внимание! На нужной Вам странице размещать компонент настоятельно рекомендуем через административный интерфейс: Контент - Структура сайта - Файлы и папки. В публичной же части компонент начинает свою работу и исключает шапку и подвал, и возвращает данные в json.

Для уменьшения нагрузки на сайта и оптимальности работы приложения данную страницу рекомендуем создать в упрощенном виде, без визуальной части:

define('NO_AGENT_CHECK', true);
define("STOP_STATISTICS", true);
require($_SERVER['DOCUMENT_ROOT'].'/bitrix/modules/main/include/prolog_before.php');
$APPLICATION->IncludeComponent(
   "scoder:api", 
   ".default", 
   array(
      "CHECK_API_KEY" => "Y",
      "API_KEY" => "test",
      "API_KEY_REQUEST" => $_REQUEST["api_key"],
      "COMPONENT_TEMPLATE" => ".default",
      "SEF_MODE" => "Y",
      "SEF_FOLDER" => "/app/",
      "SEF_URL_TEMPLATES" => array(
         "index" => "#MODE#",
      )
   ),
   false
);

К созданной Вами странице, где размещен компонент scoder:api, необходимо обращаться из приложения. Если вы разместили компонент на странице ваш_сайт/app/index.php и настроили его согласно примеру выше, то из приложения нужно обратиться к соответствующему методу, например, ваш_сайт/app/iblock.element.list и с нужными входящими параметрами, подробности по каждому методу читайте далее по документации.

Тот или иной метод возвращает код страницы и результат выполнения команды или текст ошибки, если команда по какой либо причине не сработала.

Список элементов инфоблока