Изображение на функцията на блога на VTAP

Първи стъпки с VTAP API Designer - Част 2

Преди това в нашата поредица от блогове на Vtiger Application Platform (VTAP) обсъждахме как да персонализираме интерфейса на Vtiger и да въведем персонализирани бутони и приспособления, за да отговорим на специфичните бизнес нужди. Това е само една възможност, която платформата предлага. VTAP ви предоставя много такива функции, които ви помагат:
  • Създайте персонализиран REST API
  • Свържете се с други приложения, които имат наличен REST API
  • Свържете се с приложения, поддържащи OAuth
В този блог ще обсъдя как можем да създадем персонализиран REST API. Първо, нека да поговоря малко за API на Vtiger REST. Той може да бъде достъпен с долната крайна точка, която ще бъде специфична за вашия CRM екземпляр.
Например,https://your_instance.odx.vtiger.com/restapi/v1/vtiger/default Ако сте запознати с Vtiger API за почивка, тогава можете да пропуснете раздела по -долу. За да знаете за достъпни модули, можете да използвате типове списъци 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 и да изберете модула.
Под-изображение-2
Дефинирахме Vtiger Application Definition Language (VADL), който се основава на XML синтаксис, за да даде възможност на начинаещите администратори или разработчици да определят API без опит в програмирането. VADL ви позволява да:
  • Определете CURD
    • API (създаване, актуализиране, извличане, изтриване) на модули на обекти
    • Извикайте HTTP базирана (REST/SOAP) крайна точка чрез (GET/POST/PUT/DELETE) методи
      • С удостоверяване (базиран на база / носител на жетон)
    • Приемете параметрите на заявката и ги свържете като API входове

Нека вземем пример за създаване на персонализиран REST API, който ще търси Контакти, съответстващи на домейна на имейла. Ще добавим нов API с името 'fetch_email_contact' и ще изберем модула Контакти

Код-под-изображение-1

Всички дефиниции са поставени в API възел със стандартен HTTP тип (получаване, публикуване, поставяне и изтриване). Тъй като извличаме данни от CRM, ще използваме изберете възли и предаване на имена на модули. Ще имаме полета, които трябва да бъдат извлечени вътре в запис възел и всички условия на филтъра вътре в където възел. Ние поддържаме различни видове условия като равно, не равно, като, по -голямо от, по -малко от и т.н.
По -горе е прост пример, който също може да бъде постигнат с помощта на съществуващите заявка REST API. Истинската мощ става очевидна, когато комбинирате множество API в едно.
Помислете за този пример. Актуализирате запис, ако той съществува, или създавате такъв, ако не съществува. Ако използвате съществуващ API, той ще се нуждае от множество повиквания, за да извърши тези операции. Но когато използвате API Designer, можете да комбинирате тези операции в едно API извикване.

Код-под-изображение-2

В горния пример поставяме дефиницията вътре в нагоре възел. Това включва актуализация и създаване на възел, който ще актуализира запис, ако съществува, или ще създаде запис, ако не съществува. За да идентифицирате записа, който трябва да бъде актуализиран, можете да използвате къде да филтрирате и да намерите съответните записи. В края на дефиницията възвръщащият възел ще изпрати обратно определени полета на клиента. Можете да запишете и публикувате тези 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% е отхвърлен.
Под-изображение-3 (1)

Тези API могат да бъдат достъпни вътрешно в Module Designer чрез VTAP Javascript API VTAP.CustomApi.Get за показване в приспособление или персонализирани страници в потребителския интерфейс на Vtiger.

Код-под-изображение-3

В заключение видяхме как инструментът API Designer ви позволява да пишете персонализирани REST API и да ги използвате вътрешно и в други приложения, за да консумирате CRM данни безпроблемно. За всякакви други запитвания, моля, изпратете имейл на [имейл защитен] Регистрирайте се за изданието за програмисти тук.

Tags: , , , , , , , ,

Големи малки неща: Кошче

Големи малки неща: Кошчето

Добре дошли обратно в поредицата от блогове Big Little Things, където подчертаваме някои от по-малко известните и понякога пренебрегвани функции и подобрения във Vtiger CRM...
Предимства на базата от знания

База от знания: Централизирайте информацията, за да стимулирате растежа на бизнеса

Сам притежава компания за електронно обучение, наречена „DataBridge“, която предлага онлайн програми за обучение по наука за данни. Тези курсове са достъпни за студенти и корпоративни служители, които ...
Внедряване на CRM 1

Ключове към успешното внедряване на CRM – изисквания, роли и отговорности

Добре внедреният CRM може да даде възможност на екипите по маркетинг, продажби и обслужване на клиенти да водят по-добри разговори с клиентите. Това ще подобри продажбите и удовлетвореността на клиентите. Въпреки това, ...
Изображение на базата знания

База знания, хранилище с информация, която предоставя обогатяващо изживяване на клиентите

Преди много време знанията за определен набор от умения бяха строго пазена тайна. Той беше споделен с чираци и студенти чрез специфични гилдии ...
Банер-01

Големи малки неща: Предотвратяване на дублиране

Добре дошли обратно в поредицата от блогове Big Little Things, където подчертаваме някои от по-малко известните и понякога пренебрегвани функции и подобрения във Vtiger CRM...
CRM анализ

CRM Analytics: Генерирайте отчети, предоставяйте информация, подобрявайте бизнес ефективността

Какво според вас е от съществено значение за бизнеса за подобряване на взаимоотношенията с клиентите? Ключовият елемент е да имате под ръка данни за всички дейности...
Банер-01

Vtiger Webforms: Създавайте уеб формуляри, без да се налага да пишете код

Уеб формуляри са чудесен начин за събиране на информация за контакт от вашия уебсайт. Откакто нещата станаха онлайн, фирмите започнаха да използват уеб страници за улавяне на потенциални клиенти...
Хранителен блог 1

Яжте, говорете, сътрудничете... разговори на кафе, чипс и извара.

Други хора, когато отиват в офисите си, трябва да се справят с офис политика, зли началници, голямо натоварване, бла, бла...но някои от моите колеги и...
Блог за анкети

Vtiger Проучвания: Лесно събирайте отзиви и прозрения на потребителите

Мислили ли сте някога за въпроса, който бихте искали да зададете на куп хора и да знаете тяхното мнение? Или някога сте искали да познавате хората...
Персонализиран списък с големи малки неща-01

Големи малки неща: Създаване на персонализиран списък

Добре дошли обратно в поредицата от блогове Big Little Things, където подчертаваме някои от по-малко известните и понякога пренебрегвани функции и подобрения във Vtiger CRM...
Зареждане