Как создать свое действие для бизнес-процесса

<?php
// composer require bitrix24/b24phpsdk:"^3.0"
require_once 'vendor/autoload.php';

use Bitrix24\SDK\Core\Credentials\ApplicationProfile;
use Bitrix24\SDK\Core\Credentials\AuthToken;
use Bitrix24\SDK\Core\Credentials\DefaultOAuthServerUrl;
use Bitrix24\SDK\Services\ServiceBuilderFactory;
use Monolog\Handler\StreamHandler;
use Monolog\Logger;
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\HttpFoundation\Request;

$request = Request::createFromGlobals();
$appProfile = ApplicationProfile::initFromArray([
    'BITRIX24_PHP_SDK_APPLICATION_CLIENT_ID' => getenv('B24_CLIENT_ID'),
    'BITRIX24_PHP_SDK_APPLICATION_CLIENT_SECRET' => getenv('B24_CLIENT_SECRET'),
    'BITRIX24_PHP_SDK_APPLICATION_SCOPE' => 'bizproc',
]);

$authToken = AuthToken::initFromEventRequest($request);
$domain = (string)$request->request->all('auth')['domain'];

$log = new Logger('bizproc');
$log->pushHandler(new StreamHandler('php://stdout'));

$b24 = (new ServiceBuilderFactory(new EventDispatcher(), $log))
    ->init($appProfile, $authToken, $domain, DefaultOAuthServerUrl::default());

# pip install b24pysdk flask
import hashlib
import os
from flask import Flask, request
from b24pysdk import BitrixApp, BitrixToken, Client

APP = BitrixApp(
    client_id=os.environ["B24_CLIENT_ID"],
    client_secret=os.environ["B24_CLIENT_SECRET"],
)
app = Flask(__name__)

def get_payload() -> dict:
    json_payload = request.get_json(silent=True)
    if json_payload:
        return json_payload

    form = request.form
    return {
        "event_token": form["event_token"],
        "auth": {
            "domain": form["auth[domain]"],
            "access_token": form["auth[access_token]"],
            "refresh_token": form.get("auth[refresh_token]", ""),
        },
        "properties": {
            "inputString": form.get("properties[inputString]", ""),
        },
    }

def make_client(auth: dict) -> tuple[Client, BitrixToken]:
    token = BitrixToken(
        domain=auth["domain"],
        auth_token=auth["access_token"],
        refresh_token=auth.get("refresh_token", ""),
        bitrix_app=APP,
    )
    return Client(token), token

<?php
// $b24 построен на токене установленного приложения.
// Типизированный метод activity()->add принимает расширенные DTO,
// поэтому для короткого примера используем прямой вызов через ядро SDK.
$response = $b24->core->call('bizproc.activity.add', [
    'CODE' => 'md5_action',
    'HANDLER' => 'https://your-domain.example/bp-md5-handler',
    'AUTH_USER_ID' => 1,
    'USE_SUBSCRIPTION' => 'Y',
    'NAME' => [
        'ru' => 'MD5 генератор',
        'en' => 'MD5 generator',
    ],
    'DESCRIPTION' => [
        'ru' => 'Действие возвращает MD5-хеш от входящего параметра',
        'en' => 'Activity returns MD5 hash of input parameter',
    ],
    'PROPERTIES' => [
        'inputString' => [
            'Name' => [
                'ru' => 'Входящая строка',
                'en' => 'Input string',
            ],
            'Description' => [
                'ru' => 'Введите строку для хеширования',
                'en' => 'Input string for hashing',
            ],
            'Type' => 'string',
            'Required' => 'Y',
            'Multiple' => 'N',
            'Default' => '{=Document:NAME}',
        ],
    ],
    'RETURN_PROPERTIES' => [
        'outputString' => [
            'Name' => [
                'ru' => 'MD5',
                'en' => 'MD5',
            ],
            'Type' => 'string',
            'Multiple' => 'N',
            'Default' => null,
        ],
    ],
]);

print_r($response->getResponseData()->getResult()); // true

# client построен на токене установленного приложения.
result = client.bizproc.activity.add(
    code="md5_action",
    handler="https://your-domain.example/bp-md5-handler",
    auth_user_id=1,
    use_subscription=True,
    name={
        "ru": "MD5 генератор",
        "en": "MD5 generator",
    },
    description={
        "ru": "Действие возвращает MD5-хеш от входящего параметра",
        "en": "Activity returns MD5 hash of input parameter",
    },
    properties={
        "inputString": {
            "Name": {
                "ru": "Входящая строка",
                "en": "Input string",
            },
            "Description": {
                "ru": "Введите строку для хеширования",
                "en": "Input string for hashing",
            },
            "Type": "string",
            "Required": "Y",
            "Multiple": "N",
            "Default": "{=Document:NAME}",
        },
    },
    return_properties={
        "outputString": {
            "Name": {
                "ru": "MD5",
                "en": "MD5",
            },
            "Type": "string",
            "Multiple": "N",
            "Default": None,
        },
    },
).response.result

print(result)  # True

<?php
$payload = $request->request->all();
$inputString = (string)($payload['properties']['inputString'] ?? '');
$outputString = md5($inputString);

$response = $b24->core->call('bizproc.event.send', [
    'EVENT_TOKEN' => $payload['event_token'],
    'RETURN_VALUES' => [
        'outputString' => $outputString,
    ],
    'LOG_MESSAGE' => 'Получена строка: ' . $inputString,
]);

echo json_encode([
    'result' => $response->getResponseData()->getResult(),
    'outputString' => $outputString,
]);

@app.post("/bp-md5-handler")
def bp_md5_handler():
    payload = get_payload()
    auth = payload["auth"]
    properties = payload.get("properties", {})
    input_string = str(properties.get("inputString", ""))
    output_string = hashlib.md5(input_string.encode("utf-8")).hexdigest()

    client, token = make_client(auth)
    result = token.call_method("bizproc.event.send", {
        "EVENT_TOKEN": payload["event_token"],
        "RETURN_VALUES": {
            "outputString": output_string,
        },
        "LOG_MESSAGE": f"Получена строка: {input_string}",
    })["result"]

    return {
        "result": result,
        "outputString": output_string,
    }

<?php
// install.php и bp-md5-handler.php
// composer require bitrix24/b24phpsdk:"^3.0"
require_once 'vendor/autoload.php';

use Bitrix24\SDK\Core\Credentials\ApplicationProfile;
use Bitrix24\SDK\Core\Credentials\AuthToken;
use Bitrix24\SDK\Core\Credentials\DefaultOAuthServerUrl;
use Bitrix24\SDK\Services\ServiceBuilderFactory;
use Monolog\Handler\StreamHandler;
use Monolog\Logger;
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\HttpFoundation\Request;

function buildB24(Request $request)
{
    $appProfile = ApplicationProfile::initFromArray([
        'BITRIX24_PHP_SDK_APPLICATION_CLIENT_ID' => getenv('B24_CLIENT_ID'),
        'BITRIX24_PHP_SDK_APPLICATION_CLIENT_SECRET' => getenv('B24_CLIENT_SECRET'),
        'BITRIX24_PHP_SDK_APPLICATION_SCOPE' => 'bizproc',
    ]);

    $authToken = AuthToken::initFromEventRequest($request);
    $domain = (string)$request->request->all('auth')['domain'];

    $log = new Logger('bizproc');
    $log->pushHandler(new StreamHandler('php://stdout'));

    return (new ServiceBuilderFactory(new EventDispatcher(), $log))
        ->init($appProfile, $authToken, $domain, DefaultOAuthServerUrl::default());
}

function registerActivity($b24): bool
{
    // Вызовите функцию на странице установки или настройки приложения.
    $response = $b24->core->call('bizproc.activity.add', [
        'CODE' => 'md5_action',
        'HANDLER' => 'https://your-domain.example/bp-md5-handler',
        'AUTH_USER_ID' => 1,
        'USE_SUBSCRIPTION' => 'Y',
        'NAME' => [
            'ru' => 'MD5 генератор',
            'en' => 'MD5 generator',
        ],
        'DESCRIPTION' => [
            'ru' => 'Действие возвращает MD5-хеш от входящего параметра',
            'en' => 'Activity returns MD5 hash of input parameter',
        ],
        'PROPERTIES' => [
            'inputString' => [
                'Name' => [
                    'ru' => 'Входящая строка',
                    'en' => 'Input string',
                ],
                'Type' => 'string',
                'Required' => 'Y',
                'Multiple' => 'N',
                'Default' => '{=Document:NAME}',
            ],
        ],
        'RETURN_PROPERTIES' => [
            'outputString' => [
                'Name' => [
                    'ru' => 'MD5',
                    'en' => 'MD5',
                ],
                'Type' => 'string',
                'Multiple' => 'N',
                'Default' => null,
            ],
        ],
    ]);

    return (bool)$response->getResponseData()->getResult();
}

$request = Request::createFromGlobals();
$b24 = buildB24($request);

$payload = $request->request->all();
$inputString = (string)($payload['properties']['inputString'] ?? '');
$outputString = md5($inputString);

$response = $b24->core->call('bizproc.event.send', [
    'EVENT_TOKEN' => $payload['event_token'],
    'RETURN_VALUES' => [
        'outputString' => $outputString,
    ],
    'LOG_MESSAGE' => 'Получена строка: ' . $inputString,
]);

echo json_encode([
    'result' => $response->getResponseData()->getResult(),
    'outputString' => $outputString,
]);

# app.py
# pip install b24pysdk flask
import hashlib
import os
from flask import Flask, request
from b24pysdk import BitrixApp, BitrixToken, Client

APP = BitrixApp(
    client_id=os.environ["B24_CLIENT_ID"],
    client_secret=os.environ["B24_CLIENT_SECRET"],
)
app = Flask(__name__)

def make_client(auth: dict) -> tuple[Client, BitrixToken]:
    token = BitrixToken(
        domain=auth["domain"],
        auth_token=auth["access_token"],
        refresh_token=auth.get("refresh_token", ""),
        bitrix_app=APP,
    )
    return Client(token), token

def register_activity(client: Client) -> bool:
    # Вызовите функцию на странице установки или настройки приложения.
    return client.bizproc.activity.add(
        code="md5_action",
        handler="https://your-domain.example/bp-md5-handler",
        auth_user_id=1,
        use_subscription=True,
        name={
            "ru": "MD5 генератор",
            "en": "MD5 generator",
        },
        description={
            "ru": "Действие возвращает MD5-хеш от входящего параметра",
            "en": "Activity returns MD5 hash of input parameter",
        },
        properties={
            "inputString": {
                "Name": {
                    "ru": "Входящая строка",
                    "en": "Input string",
                },
                "Type": "string",
                "Required": "Y",
                "Multiple": "N",
                "Default": "{=Document:NAME}",
            },
        },
        return_properties={
            "outputString": {
                "Name": {
                    "ru": "MD5",
                    "en": "MD5",
                },
                "Type": "string",
                "Multiple": "N",
                "Default": None,
            },
        },
    ).response.result

def get_payload() -> dict:
    json_payload = request.get_json(silent=True)
    if json_payload:
        return json_payload

    form = request.form
    return {
        "event_token": form["event_token"],
        "auth": {
            "domain": form["auth[domain]"],
            "access_token": form["auth[access_token]"],
            "refresh_token": form.get("auth[refresh_token]", ""),
        },
        "properties": {
            "inputString": form.get("properties[inputString]", ""),
        },
    }

@app.post("/bp-md5-handler")
def bp_md5_handler():
    payload = get_payload()
    properties = payload.get("properties", {})
    input_string = str(properties.get("inputString", ""))
    output_string = hashlib.md5(input_string.encode("utf-8")).hexdigest()

    client, token = make_client(payload["auth"])
    result = token.call_method("bizproc.event.send", {
        "EVENT_TOKEN": payload["event_token"],
        "RETURN_VALUES": {
            "outputString": output_string,
        },
        "LOG_MESSAGE": f"Получена строка: {input_string}",
    })["result"]

    return {
        "result": result,
        "outputString": output_string,
    }