Potencialize suas integrações com o API Designer aprimorado!

Temos o prazer de anunciar as melhorias significativas que fizemos no módulo API Designer.

Essas melhorias permitirão que você crie APIs personalizadas ainda mais eficientes e poderosas. Eles se concentram em melhorar as operações em massa, expandir a funcionalidade selecionada da API e aprimorar o uso de múltiplas condições de campo.

Vamos nos aprofundar nos detalhes dessas melhorias:

Aprimoramento 1: Suporte a operações em massa para registros UPDATE/UPSERT

API Designer: Suporte a operações em massa

Com a atualização mais recente, você pode realizar operações em massa para atualizar ou atualizar registros. Essa melhoria permite criar ou atualizar vários registros em uma única solicitação, tornando suas interações de API eficientes e economizando tempo.

Principais Recursos:

  • Criar API: Crie vários registros em uma única solicitação passando o parâmetro bulk="true". Documento Relacionado
  • Atualizar API: Anteriormente, era possível atualizar apenas um registro por solicitação. Agora, você pode atualizar vários registros em uma única solicitação, correspondendo à condição Where. Documento Relacionado

Limite de registro em massa: 50

Exemplo de caso de uso:

Módulo de Contatos: Atualize vários registros de qualquer campo com uma única solicitação. Por exemplo, você pode atualizar vários registros de contato correspondendo a condições específicas ou criando novos, caso eles não existam.

 

  
<?xml version="1.0"?>
   <api method="post" module="Contacts">
        <upsert bulk="true">
             <where>
                <field name="mobile" condition="eq" value="@mobile"></field>  
            </where>
            <update>
               <record>
                   <field name="mobile" value="@mobile"></field>
                   <field name="email" value="@email" presence="optional"></field>
                   <field name="lastname" value="@lastname" presence="optional"></field>
               </record>
            </update>
            <create module="Contacts" bulk="true">
                <record>
                   <field name="mobile" value="@mobile"></field>
                   <field name="email" value="@email" presence="optional"></field>
                   <field name="lastname" value="@lastname" presence="optional"></field>
               </record>
            </create>
            <return>
                <field name="mobile"></field>
                <field name="email"></field>
                <field name="lastname"></field>
            </return>
        </upsert>
    </api>




  
<?xml version="1.0"?>
   <api method="post" module="Contacts">
        <upsert bulk="true">
             <where>
                <field name="mobile" condition="eq" value="@mobile"></field>  
            </where>
            <update>
               <record>
                   <field name="mobile" value="@mobile"></field>
                   <field name="email" value="@email" presence="optional"></field>
                   <field name="lastname" value="@lastname" presence="optional"></field>
               </record>
            </update>
            <create module="Contacts" bulk="true">
                <record>
                   <field name="mobile" value="@mobile"></field>
                   <field name="email" value="@email" presence="optional"></field>
                   <field name="lastname" value="@lastname" presence="optional"></field>
               </record>
            </create>
            <return>
                <field name="mobile"></field>
                <field name="email"></field>
                <field name="lastname"></field>
            </return>
        </upsert>
    </api>
 

Essa melhoria simplifica seu fluxo de trabalho, reduzindo o número de chamadas de API necessárias para operações em massa.

Melhoria 2: Selecione API para oferecer suporte ao retorno de campos do módulo pai

Designer de API: API de seleção aprimorada

Expandimos a funcionalidade da API Select para incluir campos de módulos de campo de referência. Esse aprimoramento permite buscar dados abrangentes em uma única solicitação.

Principais Recursos:

  • Anteriormente, a API Select só conseguia recuperar campos do módulo atual.
  • Agora, você também pode selecionar campos de módulos de campo de referência.

Exemplos de casos de uso - Relacionamento de casos e contatos (N:1):

  • Busque registros de casos junto com os números de telefone do contato relacionado.
  • Recupere registros de casos junto com o nome e sobrenome do contato.
  • Obtenha registros de casos com o número de celular e nome completo do usuário 'Atribuído a'.
 

Essa melhoria simplifica seu fluxo de trabalho, reduzindo o número de chamadas de API necessárias para operações em massa.

Melhoria 2: Selecione API para oferecer suporte ao retorno de campos do módulo pai

Designer de API: API de seleção aprimorada

Expandimos a funcionalidade da API Select para incluir campos de módulos de campo de referência. Esse aprimoramento permite buscar dados abrangentes em uma única solicitação.

Principais Recursos:

  • Anteriormente, a API Select só conseguia recuperar campos do módulo atual.
  • Agora, você também pode selecionar campos de módulos de campo de referência.

Exemplos de casos de uso - Relacionamento de casos e contatos (N:1):

  • Busque registros de casos junto com os números de telefone do contato relacionado.
  • Recupere registros de casos junto com o nome e sobrenome do contato.
  • Obtenha registros de casos com o número de celular e nome completo do usuário 'Atribuído a'.
 

  
<?xml version="1.0"?>
<api method="get">
    <select module="Cases">
        <record>
            <field name="title"></field>
            <field name="casestatus"></field>
            <field name="assigned_user_id"></field>
            <field name="createdtime"></field>
            <field name="case_no"></field>
            <field name="assigned_user_id" module="Users">
                <select>
                    <field name="first_name"></field>
                    <field name="last_name"></field>
                    <field name="userlabel"></field>
                </select>
            </field>
            <field name="contact_id" module="Contacts">
                <select>
                    <field name="firstname"></field>
                    <field name="lastname"></field>
                    <field name="mobile"></field>
                </select>
            </field>
            <field name="group_id" module="Groups">
                <select>
                    <field name="groupname"></field>
                </select>
            </field>
        </record>
        <where>
            <field name="contact_id" module="Contacts">
                <select>
                    <where>
                        <field name="lastname" value="@name"></field>
                    </where>
                </select>
            </field>
        </where>
    </select>
</api>




  
<?xml version="1.0"?>
<api method="get">
    <select module="Cases">
        <record>
            <field name="title"></field>
            <field name="casestatus"></field>
            <field name="assigned_user_id"></field>
            <field name="createdtime"></field>
            <field name="case_no"></field>
            <field name="assigned_user_id" module="Users">
                <select>
                    <field name="first_name"></field>
                    <field name="last_name"></field>
                    <field name="userlabel"></field>
                </select>
            </field>
            <field name="contact_id" module="Contacts">
                <select>
                    <field name="firstname"></field>
                    <field name="lastname"></field>
                    <field name="mobile"></field>
                </select>
            </field>
            <field name="group_id" module="Groups">
                <select>
                    <field name="groupname"></field>
                </select>
            </field>
        </record>
        <where>
            <field name="contact_id" module="Contacts">
                <select>
                    <where>
                        <field name="lastname" value="@name"></field>
                    </where>
                </select>
            </field>
        </where>
    </select>
</api>
 

Essa melhoria permite acessar dados detalhados e interconectados, simplificando os processos de recuperação de dados.

Melhoria 3: Adicionado suporte para múltiplas condições de campo na cláusula Where

Designer de API: cláusula Where avançada

Com esta atualização, você pode usar vários campos na condição Where das suas consultas Select. Esse aprimoramento proporciona maior flexibilidade e precisão na filtragem de seus dados.

Principais Recursos:

  • Condições de múltiplos campos: adicione mais de um campo do módulo atual ou módulos de campo de referência na condição where.
  • Parâmetro Glue: Use o parâmetro Glue (glue="or" ou Glue="and") para combinar múltiplas condições.

Exemplos de casos de uso - Módulo Simples:

  • Adicione condições em 'Fase de vendas' e 'Fonte do lead' com cola = "ou".
  • Inclua campos de referência na condição Where, como contact_id e related_to.
 

Essa melhoria permite acessar dados detalhados e interconectados, simplificando os processos de recuperação de dados.

Melhoria 3: Adicionado suporte para múltiplas condições de campo na cláusula Where

Designer de API: cláusula Where avançada

Com esta atualização, você pode usar vários campos na condição Where das suas consultas Select. Esse aprimoramento proporciona maior flexibilidade e precisão na filtragem de seus dados.

Principais Recursos:

  • Condições de múltiplos campos: adicione mais de um campo do módulo atual ou módulos de campo de referência na condição where.
  • Parâmetro Glue: Use o parâmetro Glue (glue="or" ou Glue="and") para combinar múltiplas condições.

Exemplos de casos de uso - Módulo Simples:

  • Adicione condições em 'Fase de vendas' e 'Fonte do lead' com cola = "ou".
  • Inclua campos de referência na condição Where, como contact_id e related_to.
 

  
<?xml version="1.0"?>
<api method="get">
    <select module="Potentials">
        <record>
            <field name="potentialname"></field>
            <field name="amount"></field>
            <field name="assigned_user_id"></field>
            <field name="createdtime"></field>
        </record>
        <where glue="or">
            <field name="sales_stage" value="@sales_stage" presence="optional"></field>
            <field name="leadsource" value="@leadsource" presence="optional"></field>
        </where>
    </select>
</api>




  
<?xml version="1.0"?>
<api method="get">
    <select module="Potentials">
        <record>
            <field name="potentialname"></field>
            <field name="amount"></field>
            <field name="assigned_user_id"></field>
            <field name="createdtime"></field>
        </record>
        <where glue="or">
            <field name="sales_stage" value="@sales_stage" presence="optional"></field>
            <field name="leadsource" value="@leadsource" presence="optional"></field>
        </where>
    </select>
</api>
 

Exemplo complexo: Você também pode adicionar condições envolvendo campos de referência de módulos relacionados. Por exemplo:

  • Relacionamentos: Existe um relacionamento (N:1) entre negócios e contatos, bem como entre negócios e contas.
  • Condições Combinadas: Adicione condições em contact_id e related_to usando cola = "ou". Se um ou ambos os valores dos parâmetros corresponderem, a resposta será retornada.
 

Exemplo complexo: Você também pode adicionar condições envolvendo campos de referência de módulos relacionados. Por exemplo:

  • Relacionamentos: Existe um relacionamento (N:1) entre negócios e contatos, bem como entre negócios e contas.
  • Condições Combinadas: Adicione condições em contact_id e related_to usando cola = "ou". Se um ou ambos os valores dos parâmetros corresponderem, a resposta será retornada.

 

  
<?xml version="1.0"?>
<api method="get">
    <select module="Potentials">
        <record>
            <field name="potentialname"></field>
            <field name="amount"></field>
            <field name="assigned_user_id"></field>
            <field name="createdtime"></field>
        </record>
        <where glue="OR">
               <field name="contact_id" module="Contacts">
                   <select>
                       <where>
                           <field name="mobile" condition="eq" value="@mobile" presence="optional"></field>
                       </where>
                    </select>
               </field>
               <field name="related_to" module="Accounts">
                    <select>
                         <where>
                             <field name="phone" condition="eq" value="@phone" presence="optional"></field>
                         </where>
                    </select>
                </field>
            </where>
    </select>
</api>




  
<?xml version="1.0"?>
<api method="get">
    <select module="Potentials">
        <record>
            <field name="potentialname"></field>
            <field name="amount"></field>
            <field name="assigned_user_id"></field>
            <field name="createdtime"></field>
        </record>
        <where glue="OR">
               <field name="contact_id" module="Contacts">
                   <select>
                       <where>
                           <field name="mobile" condition="eq" value="@mobile" presence="optional"></field>
                       </where>
                    </select>
               </field>
               <field name="related_to" module="Accounts">
                    <select>
                         <where>
                             <field name="phone" condition="eq" value="@phone" presence="optional"></field>
                         </where>
                    </select>
                </field>
            </where>
    </select>
</api>
 

Esse aprimoramento oferece a capacidade de criar consultas mais complexas e refinadas, garantindo a recuperação exata dos dados necessários.

Acreditamos que essas melhorias melhorarão significativamente sua experiência com nosso módulo API Designer, tornando-o mais versátil e poderoso. Incentivamos você a explorar esses novos recursos e ver como eles podem beneficiar seus projetos de desenvolvimento.

Fique atento para mais atualizações.

Feliz codificação!
 

Esse aprimoramento oferece a capacidade de criar consultas mais complexas e refinadas, garantindo a recuperação exata dos dados necessários.

Acreditamos que essas melhorias melhorarão significativamente sua experiência com nosso módulo API Designer, tornando-o mais versátil e poderoso. Incentivamos você a explorar esses novos recursos e ver como eles podem beneficiar seus projetos de desenvolvimento.

Fique atento para mais atualizações.

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.