auteur Archief

Afbeelding van VTAP-blogfunctie

Aan de slag met VTAP API Designer – Deel 2

Eerder hebben we in onze blogserie Vtiger Application Platform (VTAP) besproken hoe u de Vtiger-interface kunt aanpassen en aangepaste knoppen en widgets kunt toevoegen om aan specifieke zakelijke behoeften te voldoen. Dit is slechts één mogelijkheid die het platform biedt. VTAP geeft u veel van dergelijke functies die u helpen:
  • Een aangepaste REST API maken
  • Maak verbinding met andere applicaties waarvoor REST API beschikbaar is
  • Verbinding maken met OAuth-toepassingen
In deze blog bespreek ik hoe we een custom REST API kunnen maken. Laat me eerst een beetje praten over Vtiger REST API's. Het is toegankelijk via het onderstaande eindpunt, dat specifiek is voor uw CRM-exemplaar.
Bijvoorbeeld,https://your_instance.odx.vtiger.com/restapi/v1/vtiger/default Als u op de hoogte bent van de Vtiger Rest API, dan kunt u het onderstaande gedeelte overslaan. Om meer te weten te komen over toegankelijke modules, kunt u de lijsttypen API. Hier is een screenshot van hoe u toegang krijgt tot de API met behulp van de postbode-client.

lijsttypes API

Vtiger biedt al een standaardset API's, maar met de nieuwe API Designer-tool kunt u nu uw eigen aangepaste REST-API's schrijven.

API-ontwerper
De API Designer biedt ontwikkelaars een werkbank om op HTTP gebaseerde API's te ontwikkelen die kunnen worden blootgesteld aan de VTAP Javascript API's of de externe applicatie voor eenvoudige integratie. API's kunnen worden gedefinieerd met behulp van VADL specificaties. API-toegang vereist gebruikersautorisatie en volgt de standaardconfiguratie voor recordtoegang die in de CRM is gemaakt. De API Designer biedt IDE om aangepaste API's te schrijven. Als u een aangepaste REST API schrijft voor een bepaalde module, moet u de API een naam geven en de module selecteren.
Sub-afbeelding-2
We hebben Vtiger Application Definition Language (VADL) gedefinieerd, die is gebaseerd op XML-syntaxis om beginnende beheerders of ontwikkelaars in staat te stellen API te definiëren zonder programmeerexpertise. VADL kunt u:
  • Definieer CURD
    • API's (maken, bijwerken, ophalen, verwijderen) op entiteitsmodules
    • Op HTTP gebaseerd (REST / SOAP) eindpunt aanroepen via (GET/POST/PUT/DELETE) methoden
      • Met authenticatie (Basic / Bearer token-gebaseerd)
    • Accepteer verzoekparameters en bind als API-invoer

Laten we een voorbeeld nemen van het maken van een aangepaste REST API die zoekt naar contactpersonen die overeenkomen met het e-maildomein. We zullen een nieuwe API toevoegen met de naam 'fetch_email_contact' en de module Contacten selecteren

Code-sub-afbeelding-1

Alle definities worden in een geplaatst API node met standaard HTTP-type (get, post, put en delete). Omdat we gegevens ophalen uit CRM, gebruiken we selecteer knooppunten en geef modulenamen door. We zullen velden hebben die moeten worden opgehaald in de records knooppunt en eventuele filtercondities binnen de WAAR knooppunt. We ondersteunen verschillende soorten voorwaarden zoals gelijk, niet gelijk aan, zoals, groter dan, kleiner dan, enz.
Hierboven is een eenvoudig voorbeeld, dat ook kan worden bereikt met behulp van de bestaande vraag REST API. De echte kracht wordt duidelijk wanneer u meerdere API's in één combineert.
Overweeg dit voorbeeld. U werkt een record bij als het bestaat of maakt er een aan als het niet bestaat. Als u een bestaande API gebruikt, heeft deze meerdere aanroepen nodig om deze bewerkingen uit te voeren. Maar wanneer u de API Designer gebruikt, kunt u deze bewerkingen combineren in één API-aanroep.

Code-sub-afbeelding-2

In het bovenstaande voorbeeld plaatsen we de definitie in de opperen knooppunt. Dit omvat de -update en en je merk te creëren knooppunt, dat een record bijwerkt als het bestaat of een record maakt als het niet bestaat. Om het record te identificeren dat moet worden bijgewerkt, kunt u het filter gebruiken en relevante vermeldingen vinden. Aan het einde van de definitie stuurt het retourknooppunt gedefinieerde velden terug naar de klant. U kunt deze API's opslaan en publiceren om ze beschikbaar te maken voor zowel externe applicaties als interne VTAP Javascript.

Toegang krijgen tot een aangepaste API die is gepubliceerd via de API Designer
  • Om toegang te krijgen tot een aangepaste API die is gepubliceerd via API Designer, moet u het onderstaande eindpunt gebruiken.
  • https://your_instance.odx.vtiger.com/restapi/vtap/api/API_NAME?PARAMETERS
  • API_NAME moet worden vervangen door de naam die aan de API is gegeven. Zorg er ook voor dat u het juiste HTTP-type gebruikt en geloofsbrieven(gebruikersnaam en toegangssleutel) om toegang te krijgen.
Toegang tot een recent aangemaakte fetch_email_contact API met behulp van postbode
  • Om toegang te krijgen tot een recent aangemaakte fetch_email_contact API met behulp van postbode, moet u het onderstaande gebruiken.
  • https://your_instance.odx.vtiger.com/restapi/vtap/api/fetch_email_contact?domain=%vtiger.com%
Opmerking: : https://your_instance.odx.vtiger.com/restapi/v1/ApiDesigner/api/fetch_email_contact?domain=%vtiger.com% is verouderd.
Subbeeld-3 (1)

Deze API's zijn intern toegankelijk in Module Designer met behulp van VTAP Javascript API VTAP.CustomApi.Get om in een widget of aangepaste pagina's in de Vtiger-gebruikersinterface weer te geven.

Code-sub-afbeelding-3

Tot slot hebben we gezien hoe u met de API Designer-tool aangepaste REST-API's kunt schrijven en deze intern en in andere toepassingen kunt gebruiken om CRM-gegevens naadloos te verwerken. Voor overige vragen kunt u een e-mail sturen naar: [e-mail beveiligd] Meld u aan voor de ontwikkelaarseditie hier.

AI in CRM_banner 2

Verhoog de teamproductiviteit met AI-compatibele CRMS

Customer Relationship Management (CRM) is de meest gewilde software om klantrelaties effectief te stimuleren en te beheren. Deze applicatie is robuust en heeft rijke functies zoals ...
Leadbeheer met behulp van AI Banner

Leadmanagement met AI

Richard, een verkoopmanager bij een gerenommeerd bedrijf, realiseerde zich dat zijn organisatie een groot aantal leads genereert, maar dat de conversieratio erg laag is...
Ai_aangedreven dashboard_banner

Geef uw besluitvormingsproces een boost met door AI aangedreven dashboards

Het nemen van weloverwogen beslissingen is een integraal onderdeel van een bedrijf. Met belangrijke statistieken en waardevolle inzichten kunt u alleen uw bedrijf zien groeien in de ...
Door AI gegenereerde inhoud op een slimme manier gebruiken Banner

Door AI gegenereerde inhoud: voor- en nadelen

Nu ChatGPT aan populariteit wint, zijn er voortdurend discussies geweest over de vraag of door AI gegenereerde inhoud al dan niet het doel zou dienen. Niet alleen ChatGPT, veel tools zijn ...
Boosterpakket blogbanner

Gebruik Vtiger Booster Packs om CRM-mogelijkheden uit te breiden en uw zakelijke uitdagingen aan te gaan

Hallo daar! Het nieuwe jaar kan voor veel bedrijven zowel opwinding als angst met zich meebrengen, vooral omdat het de tijd is om doelen te stellen en ...
Banner-02

Maak gebruik van AI om de nauwkeurigheid van verkoopprognoses te vergroten

Verkoop is een essentieel aspect om uw bedrijf vooruit te helpen. Elke kleine stap die je zet in een organisatie hangt af van de omzet die je genereert...
AI in klantenservicebanner

Hoe chatbots de klantenondersteuning herstructureren

Het is van vitaal belang om de huidige trends bij te houden in een op technologie gerichte wereld. Zoals besproken in onze vorige blog, is het vrij duidelijk dat kunstmatige ...
Vtiger CRM - Welkom bij 2023_Banner

Zet 2023 aan met de feature-rijke Vtiger CRM en zie uw productiviteit stijgen

Hallo daar, welkom bij een gloednieuw jaar! Laten we beginnen met u hartelijk te bedanken voor uw voortdurende vertrouwen in Vtiger CRM. Wij ...
AI transformeert CX_Banner

Hoe kunstmatige intelligentie de klantervaring transformeert

Heeft uw organisatie expertise in het leveren van een uitstekende klantervaring? Wacht..! Ben je nieuw met de term klantervaring? Als dat zo is, laat ons dan...
Do's en Don'ts_Banner (3)

De do's en don'ts anno 2023.

Nieuwjaarsdag staat voor de deur! Voor velen was 2022 een comebackjaar na de verwoestende gebeurtenissen van 2020 en de onstabiele nasleep die...
het laden
Copyright 2023 Vtiger | Privacybeleid | Beleid en juridisch centrum