Информационный бюллетень для разработчиков Vtiger CRM

Например, вы можете извлечь записи, специфичные для пользователя, с подробной информацией о текущем вошедшем в систему пользователе, предоставляя доступ к важной информации, такой как предпочтения пользователя, роли и разрешения. Вы также можете обновлять контактные данные или другие данные CRM в режиме реального времени.

В этом выпуске мы приводим следующие два примера:

Как получить данные текущего пользователя, вошедшего в систему, с помощью API VTAP?
Как получить данные по налоговому управлению (например, налоги, сборы и налоговые регионы) для модуля инвентаризации с помощью API VTAP?

Давайте посмотрим.

Пример 1: Отображение кнопки на основе ролей пользователей.


  var Contacts_Component_ListViewExamples = VTAP.Component.Core.extend({
    created() {
        var userInfo = VTAP.User();
        var userRole = userInfo.roleid.label;

        // Define the roles allowed to view the button
        var allowedRoles = ['CEO','Sales Manager'];
        if (allowedRoles.includes(userRole)) {
            VTAP.Component.Register('LIST_BASIC_BUTTON', {
                label: 'Custom Page',
                clickHandler: () => {
                    window.location.href = " ";  
                },
                icon: 'fa-check',
                variant: 'primary'
            });
        }
    }
});


  var Contacts_Component_ListViewExamples = VTAP.Component.Core.extend({
    created() {
        var userInfo = VTAP.User();
        var userRole = userInfo.roleid.label;

        // Define the roles allowed to view the button
        var allowedRoles = ['CEO','Sales Manager'];
        if (allowedRoles.includes(userRole)) {
            VTAP.Component.Register('LIST_BASIC_BUTTON', {
                label: 'Custom Page',
                clickHandler: () => {
                    window.location.href = " ";  
                },
                icon: 'fa-check',
                variant: 'primary'
            });
        }
    }
});

Внимание: Вы получите роль пользователя из VTAP.user() (информация о пользователе). На основе роли пользователя вы можете ограничить кнопку, например, показать/скрыть.

Пример 2. Как получить данные по налоговому управлению (например, налоги, сборы и налоговые регионы) для модуля инвентаризации с помощью API VTAP?

Используйте API Describe Core для получения подробной информации о конкретном модуле inventory. Например, используйте API Describe Core для получения подробной информации о модуле Quotes.


  VTAP.Api.Get("describe", { 
    "module": "Quotes", 
}, (error, response) => {
    if (error) {
        console.error("Error:", error);
    } 
});


  VTAP.Api.Get("describe", { 
    "module": "Quotes", 
}, (error, response) => {
    if (error) {
        console.error("Error:", error);
    } 
});

Внимание:

В ответе API всю информацию, связанную с сборами и налогами, можно найти в ключе chargesAndItsTaxes.
В ответе API информацию, связанную с налоговыми регионами, можно найти по ключу tax_regions.

Пример 3. Как обновить поля «Расходы» и «Общая скидка» в блоке «Элементы инвентаря»?

3a. Как обновить начисления с помощью API VTAP?

Чтобы обновить расходы, выполните следующие действия:

Извлеките запись с помощью метода VTAP.API.GET.
Получите доступ к объекту chargesAndItsTaxes в ответе и идентифицируйте каждую плату.
Измените значение ключа для каждого платежа в объекте chargesAndItsTaxes.
Отправьте обновленный объект в запросе Vtap.API.put, убедившись, что вы включили его в ключ платежей.

Примеры расходов:


  VTAP.Api.Put('records', {
        module: 'Quotes',
        id: VTAP.Detail.Id(),
        hdnProductId1:<product_id>,
        totalProductCount: 1,
        charges: {}
    }, (error, response) => {});


  VTAP.Api.Put('records', {
        module: 'Quotes',
        id: VTAP.Detail.Id(),
        hdnProductId1:<product_id>,
        totalProductCount: 1,
        charges: {}
    }, (error, response) => {});

3б. Как обновить общую скидку с помощью API VTAP?

Общая скидка представляет собой либо прямую сумму, либо процент, поэтому нам необходимо отправить тип скидки вместе с ее размером.

Пример общей скидки типа суммы:


  VTAP.Api.Put('records', {
        module: 'Quotes',
        id: VTAP.Detail.Id(),
        hdnProductId1: 490,
        totalProductCount: 1,
        discount_amount_final: 500,
        discount_type_final: 'amount',
    }, (error, response) => {});


  VTAP.Api.Put('records', {
        module: 'Quotes',
        id: VTAP.Detail.Id(),
        hdnProductId1: 490,
        totalProductCount: 1,
        discount_amount_final: 500,
        discount_type_final: 'amount',
    }, (error, response) => {});

Пример общей скидки типа «процент»:


  VTAP.Api.Put('records', {
        module: 'Quotes',
        id: VTAP.Detail.Id(),
        hdnProductId1: 490,
        totalProductCount: 1,
        discount_percentage_final: 10,
        discount_type_final: 'percentage',
    }, (error, response) => {});


  VTAP.Api.Put('records', {
        module: 'Quotes',
        id: VTAP.Detail.Id(),
        hdnProductId1: 490,
        totalProductCount: 1,
        discount_percentage_final: 10,
        discount_type_final: 'percentage',
    }, (error, response) => {});

Мы считаем, что эти примеры улучшат ваш опыт работы с API VTAP, гарантируя, что вы получите именно те данные, которые вам нужны. Оставайтесь с нами для получения дополнительной информации.

Удачного кодирования!

Подпишитесь, чтобы получать последние обновления!

Я даю Vtiger согласие на отправку обновлений о том, что нового и других интересных чтений.

Я прочитал политику конфиденциальности компании Vtiger.