Банер за API на Rest за изграждане (1)

Вашето ръководство за изграждане на REST API


API означава интерфейс за програмиране на приложения. Всеки софтуер със специфична функция се нарича приложение, когато се обсъждат API. Можете да сравните API интерфейса със споразумение за услуга между две програми, които определят заявки и отговори. Ако не сте запознати с API, препоръчваме ви да разгледате нашия Ръководство за начинаещи за API и Преглед на REST API блог, преди да прочетете този.

REST API позволяват достъп до CRM данни чрез HTTP/HTTPS протокол. Можете да извършвате действия като създаване, актуализиране, извличане или изтриване на всяка информация за CRM запис. Също така ще ви позволи да съхранявате специфични за разширение и потребителски конфигурационни данни или да се свързвате с външни приложения, като използвате съхранените специфични за разширението данни. Всички тези данни могат да бъдат достъпни с помощта на основна оторизация, тоест чрез потребителско име и ключ за достъп.

Създаване на REST API

Следват петте общи стъпки, които можете да използвате, за да създадете всеки API:
  1. Планирайте API: Насоките за проектиране на вашия API се предоставят от спецификации на API като OpenAPI. За предпочитане е предварително да се обмислят различни случаи на употреба и да се гарантира, че API отговаря на текущите стандарти за разработка на API.
  2. Изградете API: API дизайнерите създават прототипи на нови API с малко модификации на съществуващите API. Разработчиците могат да адаптират прототипа към вътрешните изисквания, след като е преминал тестване.
  3. Тествайте API: Подобно на софтуерното тестване, API тестването е необходимо за предпазване от грешки и недостатъци. Тествайте API за устойчивост срещу онлайн атаки, като използвате инструменти за тестване на API.
  4. Документирайте API: Въпреки че API се обясняват сами по себе си, документацията може да помогне на потребителите по-лесно. В ориентираната към услуги архитектура по-често се използват добре документирани API с различни функции и случаи на използване. Напишете помощен документ, за да дадете насоки и да помогнете на другите да изградят своите API.
  5. Пазарувайте API: Има онлайн пазари, където разработчиците могат да купуват и продават API на други, точно както има за стоки на дребно в eBay, Amazon и Flipkart. Можете да печелите пари от вашия API, като го посочите.
Този блог ще ви научи как да създадете персонализирана REST API команда с помощта на API Designer на Vtiger. Така че да започваме.

Какво е API дизайнер?

API Designer е инструмент или разработчиците на приложения, които могат да използват за изграждане на персонализирани API за уеб услуги. Можете да дефинирате вашите персонализирани крайни точки на услугата и параметри на заявката. Тези API могат да се използват за взаимодействие с CRM данни, интегриране с външни приложения и също така да излагат тези данни на VTAP Javascript API, които да се използват в персонализирани страници или джаджи във Vtiger UI.

Можете да създавате API с помощта на Vtiger Application Design Language (VADL), който е базиран на XML синтаксис. VADL позволява на администратори или разработчици без програмни умения на високо ниво лесно да дефинират API, но с основно разбиране на програмирането вие бързо създавате ефективни API.

REST API следват стандартен REST API протокол и можете да дефинирате техните крайни точки, както следва:
https://instance.odx.vtiger.com/restapi/vtap/api/YOUR_CUSTOM_API_PATH

За REST API се поддържат следните методи за HTTP заявка:
  • GET
  • ПУСНИ
  • PUT
  • ИЗТРИЙ
Нека да видим как можете да използвате VTAP, за да създадете свой персонализиран REST API.

Потребителите на Vtiger CRM могат да създават REST API, които ще свързват CRM с други приложения на трети страни или да създават нови, които ще разширят функционалността на CRM. Ето един пример:

Нека създадем REST API, който може достъп до данни от специфично модул с помощта на VTAP.

Следва пример за API, който извлича данни от извикания CRM модул Организации за показване на първите пет организации с най-високи годишни приходи с име на API като топ_организации. Можете да използвате различно име, за да го запазите уникален.

Преди да започнем, нека разберем XML и VDAL компонентите, които ще бъдат използвани за дефиниране на действията на горния пример за API.

Следващата таблица описва XML и VDAL компонентите, които ще се използват за дефиниране на персонализирания REST API за достъп и показване на CRM данни:
XML и VDAL компонент действие
api method=”get” Дефиниране на метод на HTTP заявка
изберете модул = "Акаунти" Дефинирайте модула за извличане на данни от използване изберете
име на поле за запис=”име на акаунт”> Дефинирайте полетата в записа, за да извлечете данни от използване рекорд
име на поле за сортиране=”годишен_приход” ред=”низходящ” /поле /сорт Определете условията за използване на резултата от таблицата вид
лимит макс=”5″ страница=”@страница” /лимит Определете броя подробности за записа, които да се показват с помощта на ограничаване на
/изберете /api Завършете със затваряне на всички отворени тагове
Забележка че всички XML и VDAL компоненти в горната таблица трябва да бъдат оградени с тагове (<>).

Следвайте тези стъпки, за да създадете REST API, обсъден по-горе:
  1. Влезте във вашия Vtiger CRM акаунт.
  2. Щракнете върху Главно меню.
  3. Кликнете платформа.
  4. Изберете API дизайнер.
  5. Кликнете +Добавяне на API.

  6. image1
  7. Кликнете Създаване на до REST API. Отваря се прозорец за добавяне на REST API.

  8. image4
  9. Добавете REST API: Въведете или изберете информация за следното:
    1. Модули: Изберете CRM модула, от който трябва да се осъществява достъп до данните.
    2. Име: Въведете уникален идентификатор за API.
    3. Статус: Щракнете върху квадратчето за отметка, за да активирате API.
  10. Кликнете Save.

  11. image2
  12. След като добавите API, ще видите вградена IDE, където ще използвате VADL, за да дефинирате API и XML възли за извличане на CRM данни. Обърнете се към таблицата по-горе, за да разберете XML и VADL компонентите.

  13. image3
  14. Кликнете Запазване и публикуване за публикуване на изградения API.
Можете да получите достъп и да тествате горния REST API от всяко външно приложение, като използвате следния URL адрес.
https://instance.odx.vtiger.com/restapi/vtap/api/top_organizations

Забележка че горният URL адрес е примерен и ще трябва да дефинирате крайната точка според вашето CRM копие.

Знаете ли, че? Горните данни могат да се използват за показване като списък на персонализирана страница или използвани за стълбовидна диаграма и други динамични резултати, като се използват компоненти на javascript за дефиниране на вашите API. Всички персонализирани REST API, изградени в API Designer, също могат да бъдат достъпни чрез VTAP Javascript API.

За да научите повече за изграждането на персонализирани API и VTAP, разгледайте VTAP документация.