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.

Tags: , , , , , , , ,

Bouwen aan een effectief team

8 technieken voor het bouwen van een effectief team

“Samenkomen is het begin. Bij elkaar blijven is vooruitgang. Samenwerken is succes.” - Henry Ford. Het bovenstaande citaat beschrijft prachtig het belang van werken ...
Blogbanner voor kantooroutfits

9 redenen waarom u zich goed moet kleden voor uw werk

Raak je in de war en gestrest bij het kiezen van je werkoutfit? Je hebt waarschijnlijk al meerdere keren gehoord hoe belangrijk het is om je goed te kleden voor...
Vtiger + Google Drive-integratiebanner

Upload en koppel documenten slim met Google Drive en Vtiger CRM-integratie

Hallo mensen! Welkom terug bij de blogserie Boost productiviteit met Google Workspace-integratie. We hopen dat u kennis kunt opdoen over Google Workspace-integratie ...
Uitdagingen op de werkplek overwinnen 2

6 manieren om uitdagingen op de werkplek te overwinnen

John T vertelt over de uitdagingen waarmee hij in zijn eerste baan te maken kreeg en hoe hij die overwon. 'In een van mijn eerste banen heb ik...
Google ontmoet Integratie 1

Maak gebruik van Google Meet-integratie met Vtiger CRM om direct vergaderlinks te delen vanuit verschillende modules

Hallo mensen! Welkom terug bij Productiviteit verhogen met de Google Workspace-integratieserie. In deze blog bespreken we de functies en voordelen van het integreren van ...
Integratie van Vtiger + Google Contacten

Exporteer en importeer gegevens naadloos met Google Contacten en Vtiger CRM-integratie

Hallo mensen! Ik hoop dat je onze serie Verhoog productiviteit met Google Workspace-integratie hebt gevolgd. De vorige twee blogs gingen over Google Workspace-integratie en ...
Gmail-integratie 3

Krijg een 360-graden klantbeeld van Gmail-integratie met Vtiger CRM

Hallo mensen! Welkom terug bij Boost Productivity met de Google Workspace-integratiereeks. Ik hoop dat je de vorige blog hebt gelezen die je een glimp geeft van ...
Google Workspace-banner

Maak gebruik van Google Workplace en verhoog de productiviteit

Hallo mensen! We zijn weer terug met weer een nieuwe blogserie: Verhoog de productiviteit met Google Workspace-integratie. In deze serie behandelen we de...
Checklist Blogbanners-031

Acht voordelen van het gebruik van checklists op het werk

Mijn moeder maakte altijd checklists voor haar boodschappen, maandelijkse uitgaven, boodschappen, enzovoort. Haar reischecklists waren legendarisch. Afhankelijk...
Banner

Stimuleer conversies met Vtiger Google Lead Forms

Leadgeneratie is een integraal onderdeel van een bedrijf. Met een effectieve leadgeneratiestrategie kunt u meer klanten toevoegen en een beter rendement creëren ...
het laden
Copyright 2022 Vtiger | Privacybeleid | Beleid en juridisch centrum