Все Активити для Битрикс24. Исходники приложения для облака.

Задача

Реализовать API для клиентов, позволяющее быстро поднять любой катомный активити для БП Битрикс24 (облако)

локальные приложения для каждого портала могут быть свои
возможность реализации общих активити для всех порталов
права доступа

Требования

наличие Битрикс Старт и выше (UTF-8)

1. Устанавливаем модуль awz.admin

Модуль хелпер для организации списков в админ панели

ссылка на модуль

2. Устанавливаем модуль awz.bxapi

Модуль хелпер для взаимодействия с Битрикс24

ссылка на модуль

3. Добавляем локальное приложение в Битрикс24

3.1. Маркет -> Разработчикам -> Другое -> Локальное приложение

3.2. Обзываем, сохраняем, запоминаем ид приложения и секретку

4. Добавляем приложение на нашем БУС сайте

4.1. Сервисы - Битрикс24 прилаги - Список приложений - Добавить

4.2. Обзываем, вписываем данные прилоежния с Битрикс24, вписываем портал

Для локальных приложений обязательно вписать домен (портал)

Для опубликованных приложений в Битрикс24 маркете задаем ALL (все порталы)

4.3. Загружаем само приложение для Битрикс24, например в папку /bx24/full_activity/

ссылка на приложение

4.4 Можно прокинуть свои роуты для апи (или оставить стандартную точку доступа через модуль main), например

// path /local/routes/api.php
use Awz\BxApi\Api\Controller;
$routes->any('/fullactivity/{method}',
    [Controller\FullActivity::class, 'forward']
)->where('method', '[a-zA-Z]+');

// path /bitrix/settings.php
[
    'routing' => [
        'value' => [
            'config' => ['api.php']
        ]
    ]
]

В случае своих routes - вписываем в pages/main.php точку api

window.awz_helper.endpointUrl = 
    'https://<?=Application::getInstance()->getContext()->getServer()->getHttpHost()?>/fullactivity/';

5. Приложение есть, вписываем урлы в интерфейсе битрикс24

параметр	значение
ссылка на приложение	https://domain/bx24/full_activity/index.php?app=<ид_прилаги_в_б24>
ссылка на установку	https://domain/bx24/full_activity/index.php?app=<ид_прилаги_в_б24>&install=Y

5.1. Жмем установку или переходим в приложение

5.2. Связываем наш апи и приложение в Битрикс24 (будет сгенерирован токен доступа к нашему апи и записан в настройки приложения в битрикс24)

Данным токеном будут подписываться все запросы на наш апи с Битрикс24, также он автоматически будет добавляться в эндпоинты наших активити

На стороне апи также сохраняется токен доступа в Битрикс24, необходимости в генерации многочисленных вебхуков в последствии нет. Доступ в Битрикс24 будет осуществляться с данного приложения.