Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Добавить кассу sale.cashbox.add». Мы подготовили подробный разбор принципов работы и развернутые примеры интеграции.

Добавить кассу sale.cashbox.add

> Scope: sale, cashbox
>
> Кто может выполнять метод: администратор CRM (право «Разрешить изменять настройки»)

Метод добавляет кассу.

Параметры метода

Параметр OFD_SETTINGS {#ofd_settings}

Примеры кода

• cURL (Webhook)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"NAME":"Rest-касса","REST_CODE":"restcashbox01","EMAIL":"user@example.com","NUMBER_KKM":"123","ACTIVE":"Y","SORT":100,"OFD":"bx_ofdruofd","OFD_SETTINGS":{"OFD_MODE":{"IS_TEST":"N"}},"SETTINGS":{"AUTH":{"KEYWORD":"top_secret!","PREFERENCE":"SECOND"},"INTERACTION":{"MODE":"ACTIVE"}}}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/sale.cashbox.add

• cURL (OAuth)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"NAME":"Rest-касса","REST_CODE":"restcashbox01","EMAIL":"user@example.com","NUMBER_KKM":"123","ACTIVE":"Y","SORT":100,"OFD":"bx_ofdruofd","OFD_SETTINGS":{"OFD_MODE":{"IS_TEST":"N"}},"SETTINGS":{"AUTH":{"KEYWORD":"top_secret!","PREFERENCE":"SECOND"},"INTERACTION":{"MODE":"ACTIVE"}},"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/sale.cashbox.add

• JS

    try
    {
    	const response = await $b24.callMethod(
    		"sale.cashbox.add",
    		{
    			"NAME": 'Rest-касса',
    			"REST_CODE": 'restcashbox01',
    			"EMAIL": "user@example.com",
    			"NUMBER_KKM": "123",
    			"ACTIVE": "Y",
    			"SORT": 100,
    			"OFD": "bx_ofdruofd",
    			"OFD_SETTINGS":
    			{
    				"OFD_MODE":
    				{
    					"IS_TEST": "N"
    				}
    			},
    			"SETTINGS":
    			{
    				"AUTH":
    				{
    					"KEYWORD": "top_secret!",
    					"PREFERENCE": "SECOND"
    				},
    				"INTERACTION":
    				{
    					"MODE": "ACTIVE"
    				}
    			}
    		}
    	);
    	
    	const result = response.getData().result;
    	if(result.error())
    		console.error(result.error());
    	else
    		console.dir(result);
    }
    catch(error)
    {
    	console.error('Error:', error);
    }

• PHP

    try {
        $response = $b24Service
            ->core
            ->call(
                'sale.cashbox.add',
                [
                    'NAME'       => 'Rest-касса',
                    'REST_CODE'  => 'restcashbox01',
                    'EMAIL'      => 'user@example.com',
                    'NUMBER_KKM' => '123',
                    'ACTIVE'     => 'Y',
                    'SORT'       => 100,
                    'OFD'        => 'bx_ofdruofd',
                    'OFD_SETTINGS' => [
                        'OFD_MODE' => [
                            'IS_TEST' => 'N'
                        ]
                    ],
                    'SETTINGS' => [
                        'AUTH' => [
                            'KEYWORD'    => 'top_secret!',
                            'PREFERENCE' => 'SECOND'
                        ],
                        'INTERACTION' => [
                            'MODE' => 'ACTIVE'
                        ]
                    ]
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
        // Нужная вам логика обработки данных
        processData($result);
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error adding cashbox: ' . $e->getMessage();
    }

• BX24.js

    BX24.callMethod(
        "sale.cashbox.add",
        {
            "NAME": 'Rest-касса',
            "REST_CODE": 'restcashbox01',
            "EMAIL": "user@example.com",
            "NUMBER_KKM": "123",
            "ACTIVE": "Y",
            "SORT": 100,
            "OFD": "bx_ofdruofd",
            "OFD_SETTINGS":
            {
                "OFD_MODE":
                {
                    "IS_TEST": "N"
                }
            },
            "SETTINGS":
            {
                "AUTH":
                {
                    "KEYWORD": "top_secret!",
                    "PREFERENCE": "SECOND"
                },
                "INTERACTION":
                {
                    "MODE": "ACTIVE"
                }
            }
        },
        function(result)
        {
            if(result.error())
                console.error(result.error());
            else
                console.dir(result.data());
        }
    );

• PHP CRest

    require_once('crest.php');

    $result = CRest::call(
        'sale.cashbox.add',
        [
            'NAME' => 'Rest-касса',
            'REST_CODE' => 'restcashbox01',
            'EMAIL' => 'user@example.com',
            'NUMBER_KKM' => '123',
            'ACTIVE' => 'Y',
            'SORT' => 100,
            'OFD' => 'bx_ofdruofd',
            'OFD_SETTINGS' =>
            [
                'OFD_MODE' =>
                [
                    'IS_TEST' => 'N'
                ]
            ],
            'SETTINGS' =>
            [
                'AUTH' =>
                [
                    'KEYWORD' => 'top_secret!',
                    'PREFERENCE' => 'SECOND'
                ],
                'INTERACTION' =>
                [
                    'MODE' => 'ACTIVE'
                ]
            ]
        ]
    );

    echo '<PRE>';
    print_r($result);
    echo '</PRE>';

• [](../../../tutorials/sale/cashbox-add-example)

Обработка ответа

HTTP-статус: 200

{
    "result": 5,
    "time": {
        "start": 1712132792.910734,
        "finish": 1712132793.530359,
        "duration": 0.6196250915527344,
        "processing": 0.032338857650756836,
        "date_start": "2024-04-03T10:26:32+02:00",
        "date_finish": "2024-04-03T10:26:33+02:00",
        "operating_reset_at": 1705765533,
        "operating": 3.3076241016387939
    }
}

Возвращаемые данные

Обработка ошибок

HTTP-статус: 400, 403

{
    "error": "ERROR_CHECK_FAILURE",
    "error_description": "Parameter NAME is not defined"
}

Возможные коды ошибок

• [](./sale-cashbox-handler-add)
• [](./sale-cashbox-handler-update)
• [](./sale-cashbox-handler-list)
• [](./sale-cashbox-handler-delete)
• [](./sale-cashbox-update)
• [](./sale-cashbox-list)
• [](./sale-cashbox-delete)
• [](./sale-cashbox-check-apply)
• [](../../../tutorials/sale/cashbox-add-example)