Use APIs VTAP para acesso, recuperação e atualizações de dados sem esforço!

As APIs do VTAP oferecem funções poderosas que permitem recuperar dados, atualizar registros, alterar dados, etc.

Com as APIs VTAP, os desenvolvedores podem facilmente executar tarefas como recuperação e atualização de dados, garantindo integração suave e gerenciamento eficiente de dados dentro do ambiente de CRM.

Por exemplo, você pode buscar registros específicos do usuário com detalhes abrangentes sobre o usuário atualmente conectado, concedendo acesso a informações vitais, como preferências do usuário, funções e permissões. Você também pode atualizar detalhes de contato ou outros dados de CRM em tempo real.

Nesta edição, damos os dois exemplos seguintes:

  • Como recuperar os detalhes de um usuário conectado no momento usando a API VTAP?
  • Como recuperar detalhes de gerenciamento de impostos (como impostos, encargos e regiões fiscais) para um módulo de inventário usando a API VTAP?

Vamos dar uma olhada.

Exemplo 1: Exibir um botão com base nas funções dos usuários.

 

  
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'
            });
        }
    }
});

Observação: Você obterá a função do usuário de VTAP.user() (informações do usuário). Com base na função do usuário, você pode restringir o botão como mostrar/ocultar.

Exemplo 2 - Como recuperar detalhes de gerenciamento de impostos (como impostos, encargos e regiões fiscais) para um módulo de inventário usando a API VTAP?

Use a API Describe Core para recuperar informações detalhadas sobre um módulo de inventário específico. Por exemplo, use a API Describe Core para buscar informações detalhadas sobre o módulo 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);
    } 
});

Observação:

  • Na resposta da API, todas as informações relacionadas a cobranças e impostos podem ser encontradas na chave chargesAndItsTaxes.
  • Na resposta da API, as informações relacionadas às regiões fiscais podem ser encontradas na chave tax_regions.

Exemplo 3 - Como atualizar os campos de bloco de itens de estoque, encargos e desconto geral?

3a. Como atualizar cobranças usando a API VTAP?

Siga estas etapas para atualizar as cobranças:

  • Recupere o registro usando o método VTAP.API.GET.
  • Acesse o objeto chargesAndItsTaxes na resposta e identifique cada cobrança.
  • Modifique o valor da chave para cada cobrança dentro do objeto chargesAndItsTaxes.
  • Envie o objeto atualizado na solicitação Vtap.API.put, certificando-se de incluí-lo na chave charges.

Exemplo de encargos:

 

  
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) => {});

3b. Como atualizar o Desconto Geral usando a API VTAP?

O desconto geral é um valor direto ou uma porcentagem, então precisamos enviar o tipo de desconto junto com o valor do desconto.

Exemplo de desconto total do tipo valor:

 

  
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) => {});

Exemplo de desconto total do tipo porcentagem:

 

  
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) => {});

Acreditamos que esses exemplos melhorarão sua experiência com APIs VTAP, garantindo que você recupere exatamente os dados de que precisa. Fique ligado para mais.

Feliz codificação!
 
 

Inscreva-se para receber as últimas atualizações!

 
 

Direitos autorais 2026 Vtiger. Todos os direitos reservados. As diversas marcas comerciais pertencem a seus respectivos proprietários.