перейти к содержанию
Главная » Мир возможностей - используйте конструктор API VTAP и подключайтесь к внешним приложениям

Мир возможностей - используйте конструктор API VTAP и подключайтесь к внешним приложениям

Последнее обновление: сентябрь 27, 2021

Опубликованный: Сентябрь 27, 2021

Конструктор API

Поскольку данные являются важным элементом нашей повседневной жизни, Vtiger стремится сделать данные легкодоступными даже вне CRM. 

Одна из самых важных особенностей Vtiger Application Platform (VTAP) - это способность передавать необходимые данные из CRM в любое место и наоборот. И объединяя VTAP Инструмент конструктора модулей, который позволяет настраивать пользовательский интерфейс, с помощью API Designer, который может подключаться к внешним приложениям, открыл мир возможностей.

Напомним, мы говорили о платформе VTAP в наших предыдущих блогах.

 

В этом блоге мы обсудим, как мы можем подключиться к другим приложениям, поддерживающим REST API, и показать данные внутри пользовательского интерфейса Vtiger. Для этого мы будем использовать: 

  • Конструктор API для подключения и получения данных из внешних приложений
  • Инструмент Module Designer для добавления пользовательского интерфейса виджета

 

Тематическое исследование: Получение сведений о погоде для местоположения контакта и отображение сведений в записи контакта.


Давайте посмотрим, как мы можем получить информацию о погоде для контакта и отобразить ее внутри виджета в контакте. Подробная страница. openweathermap.org предоставляет бесплатный погодный API. Вы можете зарегистрироваться и получить ключ API для доступа к подробнее из более чем 200,000 XNUMX городов.



Вот как это будет выглядеть в записи контакта в Vtiger CRM после подключения к OpenWeatherMap.



 

Дополнительное изображение-1

Начнем с API Designer.



Шаг 1. Использование API Designer для подключения и получения данных с openweathermap.org.


На этом этапе мы:

  • Создайте API с помощью API Designer
  • Определите конечные точки на основе HTTP

  • Как создать API с помощью API Designer?

    Во-первых, давайте создадим API для получения информации о погоде с openweathermap.org в API Designer. Следуй этим шагам:

    • Перейдите в Меню> Платформа> Конструктор API.
    • Щелкните Добавить API.
    • Добавьте имя, например, get_weather. Здесь соглашение об именах имеет решающее значение, поскольку мы будем использовать его для подключения из наших API-интерфейсов javascript.
    • Выберите модуль «Контакты», поскольку именно здесь мы создаем виджет погоды.

Дополнительное изображение-2

 

  • Определение конечных точек на основе HTTP

Все наши API зависят от ВАДЛ(Vtiger Application Definition Language), который основан на XML и позволяет вызывать любые конечные точки на основе HTTP.
Нам необходимо определить структуру конечной точки HTTP, которая обычно включает тип запроса, такой как GET, POST, PUT, DELETE, конечную точку URL, заголовки запросов и аутентификацию, такую ​​как базовая проверка подлинности и т. Д. Чтобы получить доступ к городским сведения о погоде из openweathermap.org они определили запрос GET с конечной точкой ниже.

ПОЛУЧИТЬ api.openweathermap.org/данным/2.5/weather?q= {город имя} & appid = {API ключ}

Нам нужно сопоставить это с VADL, и ему нужно что-то вроде примера ниже:

Снимок экрана в 00-04-07

Позвольте мне объяснить этот процесс шаг за шагом:

  • Любой HTTP API находится под a отдых узел с обязательным атрибутом метода, который определяет тип запроса HTTP (GET, POST и т. д.).
  • Внутри этого мы используем URL чтобы попасть в конечную точку API.
  • Обратите внимание, что есть атрибуты с URL узел. Эти атрибуты являются динамической частью конечной точки и используются для замены их значениями во время выполнения.
  • Любой атрибут с динамическим значением (добавить в начале @) будет принят при передаче в запросе; здесь мы использовали @city.
  • Для ключа API вы можете вставить значение из openweathermap. Для любого атрибута убедитесь, что вы добавили $ с именем атрибута, чтобы заменить их во время выполнения.
  • CDATA раздел внутри URL. Такие специальные символы, как &, сохраняются.

После сохранения и публикации вы можете получить доступ к API из внешних приложений, как и другие наши REST API с конечными точками. Посмотрите на URL-адрес ниже. Мы вызываем API с именем API get_weather. Вы можете получить доступ к окончательному xml из здесь так же.

https://xxxx.odx.vtiger.com/restapi/vtap/api/get_weather?city=London

Одно важное замечание: вы должны занести в белый список каждый домен API в настройках API.

Дополнительное изображение-3

Вы также можете получить доступ к этому API из Vtiger Javascript API, и мы расскажем вам, как это сделать. Перед этим мы хотим создать виджет на странице сведений, чтобы отображать информацию о погоде.
Для этого мы перейдем в Конструктор модулей, выберем Контакты и добавим TAP-скрипт.

Шаг 2. Добавление нового виджета погоды с помощью конструктора модулей 

На этом этапе мы будем 

  1. Добавить виджет на странице сведений
  2. Добавить визуальный компонент для виджета - Карта
  3. Добавьте модель всплывающего окна и настройки администратора

Начнем.

Добавление виджета

Дополнительное изображение-4

Чтобы добавить виджет на страницу с подробностями, мы предоставили API-интерфейсы javascript VTAP.Компонент.Регистр.
Это поможет вам определить тип кнопки, виджета или значка, которые вы можете добавить на определенную страницу.

Например:

  • Чтобы добавить кнопку на страницу списка, используйте "LIST_BASIC_BUTTON
  • Чтобы добавить виджет на страницу сведений, используйте «DETAIL_SUMMARY_WIDGET

Чтобы увидеть полный список таких хуков, нажмите здесь.

Чтобы определить, как должен выглядеть виджет, нам нужно добавить компонент, который будет иметь необходимый HTML. В этом случае мы переходим к компоненту WeatherWidgetContents.
В Vtiger компонент является основой любого интерфейса пользовательского интерфейса, такого как виджеты, кнопки и т. Д. Определяется базовый каркас компонента. здесь.

Снимок экрана в 00-11-50

Компонент WeatherWidgetContents выполняет следующие действия:

  • Вызовите API openweathermap get_weather, который мы создали в API Designer.
  • Загрузите некоторые основные данные, такие как текущее время, время восхода и заката, температура и общий прогноз.
  • Загрузите Open Street и покажите город на карте.

Чтобы понять структуру компонента Vtiger, вам нужно немного знать Компонент Vue поскольку наша платформа VTAP построена на нем.

Рассмотрим пример ниже. Здесь мы называем get_weather API, который мы добавили в API Designer (внутри созданной функции). VTAP.Detail.Record () Javascript API предоставляет подробную информацию о записи. Мы будем получать доступ к информации поля города рассылки контактов, чтобы получить доступ к информации о погоде.   

Снимок экрана в 00-12-43

После получения данных мы используем данные о погоде в шаблоне для их визуализации с помощью функций, специфичных для компонентов, определенных внутри методов. 

МЫ ИСПОЛЬЗУЕМ VTAP.CustomApi.Get API для получения данных с openweathermap.org путем вызова get_weather API написан в API Designer. Назначьте ответ переменной данных, чтобы к нему можно было получить доступ:

  • Компонентный метод обработки
  • Шаблон для показа. 

Многие вспомогательные функции написаны в методах, помогающих отображать время и температуру в удобочитаемом формате.
Вы можете увидеть код здесь.

Вот как это будет выглядеть, если вы сохраните и опубликуете скрипт и откроете контакт, у которого есть город рассылки. Но тебе не кажется, что это немного скучно? Почему бы не добавить карту?

Дополнительное изображение-5

 

  • Добавление визуального компонента - карта

В этом примере давайте добавим карту OpenStreet и покажем на ней город рассылки.

Чтобы добавить карту Open Street, нам сначала нужно подключить ее файл библиотеки. Библиотека Javascript в VTAP позволяет включать любую библиотеку в среду выполнения, используя VTAP.Resource.Require API.
Вы можете включить эти библиотеки при регистрации самого виджета деталей.

Снимок экрана в 00-24-23

Теперь нам нужно показать карту в WeatherWidgetContent. Начните с добавления заполнителя в шаблон и загрузки его после получения данных из API get_weather с координатами. Вы можете получить полный сценарий из наших примеров здесь и посмотрите его в действии.

 

Дополнительное изображение-6

Теперь предположим, что вы хотите выпустить это как модуль расширения, и каждый клиент хочет установить его и использовать свой собственный ключ API openweathermap.org. Для этого мы можем хранить данные клиентов с помощью наших API-интерфейсов хранилища javascript, к которым можно получить доступ в API Designer с помощью переменные-заполнители.

 

  • Добавление модели всплывающего окна и настроек администратора

Давайте создадим небольшое модальное всплывающее окно, к которому только администраторы могут получить доступ и сохранить ключ API в нашем хранилище данных. Сначала зарегистрируйте компонент, чтобы настройки отображались на странице списка.

Снимок экрана в 00-30-37

Вот как это будет выглядеть на странице списка.

Дополнительное изображение-7

 

  • Хранение данных в Vtiger

Мы будем использовать VTAP.AppData API для хранения и получения ключей API. Обратите внимание, что мы используем weather_apikey в качестве ключа для хранения, и к нему можно получить доступ в API Designer с помощью $ apps. $ App.Contacts.weather_apikey.

Снимок экрана в 23-57-00

Вы можете получить доступ ко всему коду WeatherSettings из здесь.

После использования API данных хранилища VTAP для хранения ключа API мы можем изменить определение get_weather в API Designer, как показано ниже. Мы заменяем прямое значение ключа на $ apps. $ app.Contacts.weather_apikey.

Снимок экрана в 23-43-36

Теперь вы находитесь в состоянии, когда вы можете опубликовать свое расширение на нашем рынке, поскольку вы сделали ключ API настраиваемым для каждого клиента.

По любым другим вопросам, пожалуйста, отправьте электронное письмо по адресу [электронная почта защищена].
Подпишитесь на версию для разработчиков здесь.

✦
Развивайте свой бизнес с помощью универсальной CRM-системы Vtiger.
Попробуйте Vtiger бесплатно