Geef uw integraties een boost met de verbeterde API Designer!

We zijn blij om de aanzienlijke verbeteringen aan te kondigen die we hebben aangebracht in de API Designer-module.

Dankzij deze verbeteringen kunt u nog efficiëntere en krachtigere aangepaste API's bouwen. Ze richten zich op het verbeteren van bulkoperaties, het uitbreiden van geselecteerde API-functionaliteit en het verbeteren van het gebruik van meerdere veldomstandigheden.

Laten we eens kijken naar de details van deze verbeteringen:

Verbetering 1: Ondersteuning voor bulkbewerkingen voor UPDATE/UPSERT-records

API-ontwerper: ondersteuning voor bulkbewerkingen

Met de nieuwste update kunt u bulkbewerkingen uitvoeren voor het bijwerken of bijwerken van records. Met deze verbetering kunt u meerdere records in één verzoek maken of bijwerken, waardoor uw API-interacties efficiënt en tijdbesparend worden.

Belangrijkste kenmerken:

  • API maken: Maak meerdere records in één verzoek door de parameter bulk="true" door te geven. Verwant document
  • Update-API: Voorheen kon u slechts één record per verzoek bijwerken. Nu kunt u meerdere records in één verzoek bijwerken door aan de Where-voorwaarde te voldoen. Verwant document

Bulkrecordlimiet: 50

Voorbeeldgebruikscasus:

Contactenmodule: Update meerdere records van elk veld met één verzoek. U kunt bijvoorbeeld meerdere contactrecords bijwerken door aan specifieke voorwaarden te voldoen of nieuwe te maken als deze niet bestaan.


  

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

 

Deze verbetering stroomlijnt uw workflow, waardoor het aantal API-aanroepen dat nodig is voor bulkbewerkingen wordt verminderd.

Verbetering 2: Selecteer API ter ondersteuning van terugkerende bovenliggende modulevelden

API-ontwerper: verbeterde selectie-API

We hebben de functionaliteit van Select API uitgebreid met velden uit referentieveldmodules. Met deze verbetering kunt u uitgebreide gegevens in één verzoek ophalen.

Belangrijkste kenmerken:

  • Voorheen kon de Select API alleen velden uit de huidige module ophalen.
  • Nu kunt u ook velden uit referentieveldmodules selecteren.

Voorbeeldgebruikscasussen - Cases en contactrelaties (N:1):

  • Haal dossierrecords op samen met de telefoonnummers van de gerelateerde contactpersoon.
  • Haal casusrecords op, samen met de voor- en achternaam van de contactpersoon.
  • Ontvang caserecords met het mobiele nummer en de volledige naam van de gebruiker 'Toegewezen aan'.
 

Deze verbetering stroomlijnt uw workflow, waardoor het aantal API-aanroepen dat nodig is voor bulkbewerkingen wordt verminderd.

Verbetering 2: Selecteer API ter ondersteuning van terugkerende bovenliggende modulevelden

API-ontwerper: verbeterde selectie-API

We hebben de functionaliteit van Select API uitgebreid met velden uit referentieveldmodules. Met deze verbetering kunt u uitgebreide gegevens in één verzoek ophalen.

Belangrijkste kenmerken:

  • Voorheen kon de Select API alleen velden uit de huidige module ophalen.
  • Nu kunt u ook velden uit referentieveldmodules selecteren.

Voorbeeldgebruikscasussen - Cases en contactrelaties (N:1):

  • Haal dossierrecords op samen met de telefoonnummers van de gerelateerde contactpersoon.
  • Haal casusrecords op, samen met de voor- en achternaam van de contactpersoon.
  • Ontvang caserecords met het mobiele nummer en de volledige naam van de gebruiker 'Toegewezen aan'.

  

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

 

Deze verbetering geeft u toegang tot gedetailleerde en onderling verbonden gegevens, waardoor de processen voor het ophalen van gegevens worden vereenvoudigd.

Verbetering 3: Ondersteuning toegevoegd voor meerdere veldomstandigheden in de Where-clausule

API Designer: geavanceerde Where-clausule

Met deze update kunt u meerdere velden gebruiken in de Where-voorwaarde van uw Select-query's. Deze verbetering biedt meer flexibiliteit en precisie bij het filteren van uw gegevens.

Belangrijkste kenmerken:

  • Meerdere veldvoorwaarden: Voeg meer dan één veld toe uit de huidige module of referentieveldmodules in de waar-voorwaarde.
  • Lijmparameter: Gebruik de lijmparameter (glue='or' of 'glue='en') om meerdere voorwaarden te combineren.

Voorbeeldgebruiksscenario's - Eenvoudige module:

  • Voeg voorwaarden toe aan 'Verkoopfase' en 'Leadbron' met lijm="or".
  • Neem referentievelden op in de Where-voorwaarde, zoals contact_id enrelated_to.
 

Deze verbetering geeft u toegang tot gedetailleerde en onderling verbonden gegevens, waardoor de processen voor het ophalen van gegevens worden vereenvoudigd.

Verbetering 3: Ondersteuning toegevoegd voor meerdere veldomstandigheden in de Where-clausule

API Designer: geavanceerde Where-clausule

Met deze update kunt u meerdere velden gebruiken in de Where-voorwaarde van uw Select-query's. Deze verbetering biedt meer flexibiliteit en precisie bij het filteren van uw gegevens.

Belangrijkste kenmerken:

  • Meerdere veldvoorwaarden: Voeg meer dan één veld toe uit de huidige module of referentieveldmodules in de waar-voorwaarde.
  • Lijmparameter: Gebruik de lijmparameter (glue='or' of 'glue='en') om meerdere voorwaarden te combineren.

Voorbeeldgebruiksscenario's - Eenvoudige module:

  • Voeg voorwaarden toe aan 'Verkoopfase' en 'Leadbron' met lijm="or".
  • Neem referentievelden op in de Where-voorwaarde, zoals contact_id enrelated_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>

 

Complex voorbeeld: U kunt ook voorwaarden toevoegen met betrekking tot referentievelden uit gerelateerde modules. Bijvoorbeeld:

  • Relaties: Er bestaat een relatie (N:1) tussen Deals en Contacten, maar ook tussen Deals en Accounts.
  • Gecombineerde voorwaarden: Voeg voorwaarden toe aan contact_id enrelated_to met behulp van lijm="or". Als een of beide parameterwaarden overeenkomen, wordt het antwoord geretourneerd.

 

Complex voorbeeld: U kunt ook voorwaarden toevoegen met betrekking tot referentievelden uit gerelateerde modules. Bijvoorbeeld:

  • Relaties: Er bestaat een relatie (N:1) tussen Deals en Contacten, maar ook tussen Deals en Accounts.
  • Gecombineerde voorwaarden: Voeg voorwaarden toe aan contact_id enrelated_to met behulp van lijm="or". Als een of beide parameterwaarden overeenkomen, wordt het antwoord geretourneerd.


  

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

 

Deze verbetering geeft u de mogelijkheid om complexere en verfijndere query's te maken, zodat u precies de gegevens kunt ophalen die u nodig heeft.

Wij zijn ervan overtuigd dat deze verbeteringen uw ervaring met onze API Designer-module aanzienlijk zullen verbeteren, waardoor deze veelzijdiger en krachtiger wordt. We moedigen u aan deze nieuwe functies te verkennen en te zien hoe deze uw ontwikkelingsprojecten ten goede kunnen komen.

Blijf op de hoogte voor meer updates.

Veel plezier met coderen!

 

Deze verbetering geeft u de mogelijkheid om complexere en verfijndere query's te maken, zodat u precies de gegevens kunt ophalen die u nodig heeft.

Wij zijn ervan overtuigd dat deze verbeteringen uw ervaring met onze API Designer-module aanzienlijk zullen verbeteren, waardoor deze veelzijdiger en krachtiger wordt. We moedigen u aan deze nieuwe functies te verkennen en te zien hoe deze uw ontwikkelingsprojecten ten goede kunnen komen.

Blijf op de hoogte voor meer updates.

Veel plezier met coderen!

 
 

Schrijf je in om de laatste updates te ontvangen!