Eerder hebben we in onze Vtiger Application Platform (VTAP) blogserie besproken hoe we de Vtiger-interface kunnen aanpassen en aangepaste knoppen en widgets kunnen toevoegen om tegemoet te komen aan specifieke zakelijke behoeften. Dit is slechts één mogelijkheid die het platform biedt.
VTAP biedt 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 met 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 kunt krijgen tot de API met behulp van de postman-client.
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 standaard recordtoegangsconfiguratie die binnen de CRM is gemaakt.
De API Designer biedt IDE om aangepaste API's te schrijven. Als u een aangepaste REST API voor een bepaalde module schrijft, moet u de API een naam geven en de module selecteren.
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
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.
In het bovenstaande voorbeeld plaatsen we de definitie in de opperen knooppunt. Dit omvat de -update en en je merk te creëren node, die een record zal bijwerken als het bestaat of een record zal maken als het niet bestaat. Om de record te identificeren die moet worden bijgewerkt, kunt u de filter gebruiken om relevante ingangen te vinden. Aan het einde van de definitie stuurt het retourknooppunt gedefinieerde velden terug naar de client.
U kunt deze API's opslaan en publiceren om ze beschikbaar te maken voor zowel externe toepassingen 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%
Note : https://your_instance.odx.vtiger.com/restapi/v1/ApiDesigner/api/fetch_email_contact?domain=%vtiger.com% is verouderd.
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.
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 naadloos CRM-gegevens te gebruiken.
Voor overige vragen kunt u een e-mail sturen naar: [e-mail beveiligd]. Meld u aan voor de ontwikkelaarseditie hier..
