Преди това в нашата поредица от блогове на Vtiger Application Platform (VTAP) обсъждахме как да персонализираме интерфейса на Vtiger и да въведем персонализирани бутони и приспособления, за да отговорим на специфичните бизнес нужди. Това е само една възможност, която платформата предлага.
VTAP ви предоставя много такива функции, които ви помагат:
- Създайте персонализиран REST API
- Свържете се с други приложения, които имат наличен REST API
- Свържете се с приложения, поддържащи OAuth
В този блог ще обсъдя как можем да създадем персонализиран REST API.
Първо, позволете ми да говоря малко за Vtiger REST API. Той може да бъде достъпен с крайната точка по-долу, която ще бъде специфична за вашето CRM копие.
Например,https://your_instance.odx.vtiger.com/restapi/v1/vtiger/default
Ако сте запознати с Vtiger API за почивка, тогава можете да пропуснете раздела по -долу. За да знаете за достъпни модули, можете да използвате типове списъци API.
Ето екранна снимка как можете да получите достъп до API с помощта на клиента на пощальона.
Vtiger вече предоставя стандартен набор от API, но с новия инструмент API Designer вече можете да напишете свои собствени персонализирани REST API.
API дизайнер
API Designer предоставя работна среда за разработчиците да разработват HTTP-базирани API, които могат да бъдат изложени на VTAP Javascript API или външното приложение за лесна интеграция. API могат да бъдат дефинирани с помощта VADL спецификации.
API достъпът се нуждае от оторизация на потребителя и следва стандартната конфигурация за достъп до запис, направена в CRM.
API Designer предоставя IDE за писане на персонализирани API. Ако пишете персонализиран REST API за определен модул, трябва да дадете име на API и да изберете модула.
Дефинирахме Vtiger Application Definition Language (VADL), който се основава на XML синтаксис, за да даде възможност на начинаещите администратори или разработчици да определят API без опит в програмирането.
VADL ви позволява да:
- Определете CURD
- API (създаване, актуализиране, извличане, изтриване) на модули на обекти
- Извикайте HTTP базирана (REST/SOAP) крайна точка чрез (GET/POST/PUT/DELETE) методи
- С удостоверяване (базиран на база / носител на жетон)
- Приемете параметрите на заявката и ги свържете като API входове
Нека вземем пример за създаване на персонализиран REST API, който ще търси Контакти, съответстващи на домейна на имейла. Ще добавим нов API с името 'fetch_email_contact' и ще изберем модула Контакти
Всички дефиниции са поставени в API възел със стандартен HTTP тип (получаване, публикуване, поставяне и изтриване). Тъй като извличаме данни от CRM, ще използваме изберете възли и предаване на имена на модули. Ще имаме полета, които трябва да бъдат извлечени вътре в запис възел и всички условия на филтъра вътре в където възел. Ние поддържаме различни видове условия като равно, не равно, като, по -голямо от, по -малко от и т.н.
По -горе е прост пример, който също може да бъде постигнат с помощта на съществуващите заявка REST API. Истинската мощ става очевидна, когато комбинирате множество API в едно.
Помислете за този пример. Актуализирате запис, ако той съществува, или създавате такъв, ако не съществува. Ако използвате съществуващ API, той ще се нуждае от множество повиквания, за да извърши тези операции. Но когато използвате API Designer, можете да комбинирате тези операции в едно API извикване.
В горния пример поставяме дефиницията вътре в нагоре възел. Това включва актуализация намлява създаване на възел, който ще актуализира запис, ако съществува, или ще създаде запис, ако не съществува. За да идентифицирате записа, който трябва да бъде актуализиран, можете да използвате къде да филтрирате и да намерите съответните записи. В края на дефиницията възвръщащият възел ще изпрати обратно определени полета на клиента.
Можете да запазите и публикувате тези API, за да ги направите достъпни за външни приложения, както и за вътрешен VTAP Javascript.
Достъп до персонализиран API, публикуван чрез API Designer
- За достъп до всеки персонализиран API, публикуван чрез API Designer, ще трябва да използвате долната крайна точка.
- https://your_instance.odx.vtiger.com/restapi/vtap/api/API_NAME? ПАРАМЕТРИ
- API_NAME трябва да бъде заменен с името, дадено на API. Също така се уверете, че използвате подходящия HTTP тип и акредитивни писма(потребителско име и ключ за достъп) за достъп до него.
Достъп до наскоро създаден fetch_email_contact API с помощта на пощальон
- За достъп до наскоро създаден fetch_email_contact API, използващ пощальон, трябва да използвате по -долу.
- https://your_instance.odx.vtiger.com/restapi/vtap/api/fetch_email_contact?domain=%vtiger.com%
Забележка : https://your_instance.odx.vtiger.com/restapi/v1/ApiDesigner/api/fetch_email_contact?domain=%vtiger.com% е отхвърлен.
Тези API могат да бъдат достъпни вътрешно в Module Designer чрез VTAP Javascript API VTAP.CustomApi.Get за показване в приспособление или персонализирани страници в потребителския интерфейс на Vtiger.
В заключение видяхме как инструментът API Designer ви позволява да пишете персонализирани REST API и да ги използвате вътрешно и в други приложения, за да консумирате безпроблемно CRM данни.
За всякакви други запитвания, моля, изпратете имейл на [имейл защитен]. Регистрирайте се за изданието за разработчици тук.
