Улучшите свою интеграцию с помощью улучшенного конструктора API!

Мы рады сообщить о значительных улучшениях, которые мы внесли в модуль API Designer.

Эти улучшения позволят вам создавать еще более эффективные и мощные пользовательские API. Они сосредоточены на улучшении массовых операций, расширении некоторых функций API и расширении использования различных полевых условий.

Давайте углубимся в детали этих улучшений:

Улучшение 1. Поддержка массовых операций для записей UPDATE/UPSERT.

API Designer: поддержка массовых операций

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

Ключевые особенности:

  • Создать API: Создайте несколько записей в одном запросе, передав параметр Bulk="true". Связанный документ
  • Обновить API: Раньше вы могли обновить только одну запись за один запрос. Теперь вы можете обновить несколько записей в одном запросе, сопоставив условие Where. Связанный документ

Ограничение массовой записи: 50

Пример варианта использования:

Модуль контактов: Обновите несколько записей любого поля одним запросом. Например, вы можете обновить несколько записей контактов, сопоставив определенные условия или создав новые, если они не существуют.

 

  
<?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>
 

Это усовершенствование оптимизирует ваш рабочий процесс, сокращая количество вызовов API, необходимых для массовых операций.

Улучшение 2: выберите API для поддержки возврата полей родительского модуля

API Designer: расширенный API выбора

Мы расширили функциональность Select API, включив в нее поля из ссылочных модулей полей. Это усовершенствование позволяет получать полные данные за один запрос.

Ключевые особенности:

  • Раньше API Select мог извлекать поля только из текущего модуля.
  • Теперь вы также можете выбирать поля из справочных модулей полей.

Примеры вариантов использования – связь случаев и контактов (N:1):

  • Получите записи дел вместе с телефонными номерами соответствующих контактов.
  • Получите записи о случаях заболевания вместе с именем и фамилией контакта.
  • Получайте записи о делах с указанием номера мобильного телефона и полного имени пользователя, которому назначено.
 

Это усовершенствование оптимизирует ваш рабочий процесс, сокращая количество вызовов API, необходимых для массовых операций.

Улучшение 2: выберите API для поддержки возврата полей родительского модуля

API Designer: расширенный API выбора

Мы расширили функциональность Select API, включив в нее поля из ссылочных модулей полей. Это усовершенствование позволяет получать полные данные за один запрос.

Ключевые особенности:

  • Раньше API Select мог извлекать поля только из текущего модуля.
  • Теперь вы также можете выбирать поля из справочных модулей полей.

Примеры вариантов использования – связь случаев и контактов (N:1):

  • Получите записи дел вместе с телефонными номерами соответствующих контактов.
  • Получите записи о случаях заболевания вместе с именем и фамилией контакта.
  • Получайте записи о делах с указанием номера мобильного телефона и полного имени пользователя, которому назначено.
 

  
<?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>
 

Это усовершенствование позволяет получить доступ к подробным и взаимосвязанным данным, упрощая процессы поиска данных.

Улучшение 3: добавлена ​​поддержка нескольких условий полей в предложении Where.

API Designer: расширенное предложение Where

Благодаря этому обновлению вы можете использовать несколько полей в условии «Где» ваших запросов «Выбрать». Это усовершенствование обеспечивает большую гибкость и точность фильтрации данных.

Ключевые особенности:

  • Условия нескольких полей: добавьте более одного поля из текущего модуля или ссылайтесь на модули полей в условии где.
  • Параметр Glue: используйте параметр Glue (glue="или" или Glue="and") для объединения нескольких условий.

Примеры использования — простой модуль:

  • Добавьте условия на «Этап продаж» и «Источник потенциальных клиентов» с помощью Glue="or".
  • Включите в условие «Где» ссылочные поля, такие как contact_id и linked_to.
 

Это усовершенствование позволяет получить доступ к подробным и взаимосвязанным данным, упрощая процессы поиска данных.

Улучшение 3: добавлена ​​поддержка нескольких условий полей в предложении Where.

API Designer: расширенное предложение Where

Благодаря этому обновлению вы можете использовать несколько полей в условии «Где» ваших запросов «Выбрать». Это усовершенствование обеспечивает большую гибкость и точность фильтрации данных.

Ключевые особенности:

  • Условия нескольких полей: добавьте более одного поля из текущего модуля или ссылайтесь на модули полей в условии где.
  • Параметр Glue: используйте параметр Glue (glue="или" или Glue="and") для объединения нескольких условий.

Примеры использования — простой модуль:

  • Добавьте условия на «Этап продаж» и «Источник потенциальных клиентов» с помощью Glue="or".
  • Включите в условие «Где» ссылочные поля, такие как contact_id и linked_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>
 

Сложный пример: Вы также можете добавить условия, включающие ссылочные поля из связанных модулей. Например:

  • Отношения: Между Сделками и Контактами, а также между Сделками и Счетами существует связь (N:1).
  • Комбинированные условия: Добавьте условия для contact_id и linked_to, используя Glue="or". Если одно или оба значения параметра совпадают, будет возвращен ответ.
 

Сложный пример: Вы также можете добавить условия, включающие ссылочные поля из связанных модулей. Например:

  • Отношения: Между Сделками и Контактами, а также между Сделками и Счетами существует связь (N:1).
  • Комбинированные условия: Добавьте условия для contact_id и linked_to, используя Glue="or". Если одно или оба значения параметра совпадают, будет возвращен ответ.

 

  
<?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>
 

Это усовершенствование дает вам возможность создавать более сложные и уточненные запросы, гарантируя получение именно тех данных, которые вам нужны.

Мы считаем, что эти улучшения значительно улучшат вашу работу с нашим модулем API Designer, сделав его более универсальным и мощным. Мы рекомендуем вам изучить эти новые функции и посмотреть, какую пользу они могут принести вашим проектам разработки.

Следите за обновлениями.

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

Это усовершенствование дает вам возможность создавать более сложные и уточненные запросы, гарантируя получение именно тех данных, которые вам нужны.

Мы считаем, что эти улучшения значительно улучшат вашу работу с нашим модулем API Designer, сделав его более универсальным и мощным. Мы рекомендуем вам изучить эти новые функции и посмотреть, какую пользу они могут принести вашим проектам разработки.

Следите за обновлениями.

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

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

 
 

Copyright 2026 Vtiger. Все права защищены. Различные торговые марки принадлежат их соответствующим владельцам.