Scoder: Rest API для БУС. Бэкенд мобильных приложений. Конструктор запросов

Технические данные

Совместимые редакции

• Программа для ЭВМ "1С-Битрикс: Управление сайтом". Лицензия Старт
• Программа для ЭВМ "1С-Битрикс: Управление сайтом". Лицензия Стандарт
• Программа для ЭВМ "1С-Битрикс: Управление сайтом". Лицензия Малый бизнес
• Программа для ЭВМ "1С-Битрикс24". Лицензия Стандартный (12 мес.)
• Программа для ЭВМ "1С-Битрикс: Управление сайтом". Лицензия Бизнес
• Программа для ЭВМ "1С-Битрикс24". Лицензия Интернет-магазин + CRM (12 мес.)
• Программа для ЭВМ "1С-Битрикс24". Лицензия "Энтерпрайз-500" (облако, 12 мес.)

Описание

Внимание! На момент публикации модуля реализован очень ограниченный перечень методов.

Модуль может быть применен:

• При разработке мобильных приложений для реализации их серверной части.
  
• Разработки иных приложений, взаимодействующих с веб-сайтом.
  
• Для синхронизации с 1С: реализация нестандартных принципов обмена элементов (товаров), заказов, пользователей.
  
• Для интеграции с иными внешними ресурсами, маркетплейсами, партнерами, агрегаторами...
  

Доступные методы:

• iblock.element.list - список элементов инфоблока
  
• iblock.element.add - добавление элемента инфоблока
  
• iblock.element.update - изменение элемента инфоблока
  
• iblock.element.delete - удаление элемента инфоблока
  
• iblock.section.list - список разделов инфоблока
  
• iblock.section.add - добавление раздела инфоблока
  
• iblock.section.update - изменение раздела инфоблока
  
• iblock.section.delete - удаление раздела инфоблока
  
• user.list - список пользователей
  
• user.add - добавление пользователя
  
• user.update - изменение пользователя
  
• user.delete - удаление пользователя
  
• user.otp - авторизация (запрос ОТП)
  
• user.otp.authorize - авторизация по ОТП
  
• user.authorize - авторизация по логин-паролю или токену (UF_TOKEN).
  
• user.forgotpasswd - восстановление пароля (отправка контрольной строки, смена пароля с помощью контрольной строки).
  
• произвольные запросы типа сущность.list
  
• sale.order.add - добавление заказа
  
• sale.order.update - изменение заказа.
  
• sale.order.deliveries - запрос служб доставки.
  
• sale.order.payments - запрос платежных систем.
  

КОНСТРУКТОР ЗАПРОСОВ:

Конструктор запросов модуля - это механизм создания предустановленных запросов для получения данных с сайта. Доступен на странице: Сервисы > Scoder: Rest API для БУС > Профили.

Данный функционал позволяет облегчить труд разработчиков мобильных приложений и других аналогичных специалистов, т.к. на практике очень часто бывает, что разработчики внешних приложений мало знакомы с работой сайтов на 1С-Битрикс. С помощью конструктора можно заготовить методы для работы мобильных приложений и предоставить ссылки, при запросе на которые, будут отдаваться нужные данные (см. ниже примеры).

Доступны следующие методы:

• Список элементов инфоблока. Т.е. в профилях модуля можно указать заранее известный фильтр, сортировку, возвращаемые поля, количество возвращаемых записей, и обращаться для получения данных к указанным адресам без лишних параметров. Но также заложена возможность переопределить заданные параметры параметрами из post-запроса.
  
• Список разделов инфоблока.
  
• Список пользователей.
  
• Произвольная PHP функция, с помощью которой можно реализовать любой алгоритм и вернуть любые данные с вашего сайта при наличии навыков программирования.
  
• Список записей из таблицы. Метод getlist. Таблица, с которой будет происходить работы в рамках профиля,  указывается в его настройках. Используемая технология ORM.
  

• Механизм работы похож на механизм работы с RestAPI Битрикс24.
  
• Подробнее в документации.
  

ПРИМЕРЫ:

• Интеграция 1С-Битрикс с сервисом мобильных приложений imshop.io с помощью модуля scoder.api
  
• Дублирование пользователей в инфоблоки на ЦМС 1С-Битрикс
  

ВНИМАНИЕ:

• Для корректной работы модуля необходимо, чтобы на сайте были установлены все последние обновления модулей 1с-Битрикс и тест Настройки -> Инструменты -> Проверка системы не должен возвращать ошибок.
  
• Данный модуль разработан с использованием апи D7, смотрите минимальные тех. требования для ядра D7.