Obraz funkcji bloga VTAP

Pierwsze kroki z VTAP API Designer – część 2

Wcześniej w naszej serii blogów Vtiger Application Platform (VTAP) omawialiśmy, jak dostosować interfejs Vtiger i wprowadzić niestandardowe przyciski i widżety, aby zaspokoić określone potrzeby biznesowe. To tylko jedna z możliwości oferowanych przez platformę. VTAP daje Ci wiele takich funkcji, które pomagają:
  • Utwórz niestandardowy interfejs API REST
  • Połącz się z innymi aplikacjami, które mają REST API dostępne
  • Połącz się z aplikacjami obsługującymi OAuth
W tym blogu omówię, w jaki sposób możemy stworzyć niestandardowe API REST. Najpierw pozwól, że porozmawiam trochę o interfejsach API Vtiger REST. Można uzyskać do niego dostęp za pomocą poniższego punktu końcowego, który będzie specyficzny dla Twojego wystąpienia CRM.
Na przykład,https://your_instance.odx.vtiger.com/restapi/v1/vtiger/default Jeśli znasz Vtiger Reszta API, możesz pominąć poniższą sekcję. Aby dowiedzieć się o dostępnych modułach, możesz użyć typy list API. Oto zrzut ekranu pokazujący, jak uzyskać dostęp do interfejsu API za pomocą klienta listonosza.

API typów list

Vtiger zapewnia już standardowy zestaw interfejsów API, ale dzięki nowemu narzędziu API Designer możesz teraz pisać własne niestandardowe interfejsy API REST.

Projektant API
API Designer zapewnia programistom środowisko pracy do tworzenia interfejsów API opartych na protokole HTTP, które mogą być udostępniane interfejsom API JavaScript VTAP lub zewnętrznej aplikacji w celu łatwej integracji. API można zdefiniować za pomocą VADL specyfikacje. Dostęp API wymaga autoryzacji użytkownika i jest zgodny ze standardową konfiguracją dostępu do rekordów dokonaną w CRM. Projektant API udostępnia IDE do pisania niestandardowych interfejsów API. Jeśli piszesz niestandardowy interfejs API REST dla konkretnego modułu, musisz nazwać interfejs API i wybrać moduł.
Obraz podrzędny-2
Zdefiniowaliśmy język definicji aplikacji Vtiger (VADL), który opiera się na składni XML, aby umożliwić początkującym administratorom lub programistom zdefiniowanie interfejsu API bez wiedzy programistycznej. VADL pozwala Ci na:
  • Zdefiniuj twaróg
    • API (Create, Update, Retrieve, Delete) na modułach encji
    • Wywołaj punkt końcowy oparty na HTTP (REST / SOAP) za pomocą metod (GET/POST/PUT/DELETE)
      • Z uwierzytelnianiem (podstawowe / oparte na tokenie okaziciela)
    • Zaakceptuj parametry żądania i powiąż jako dane wejściowe API

Weźmy przykład tworzenia niestandardowego interfejsu API REST, który będzie wyszukiwał kontakty pasujące do domeny poczty e-mail. Dodamy nowe API o nazwie 'fetch_email_contact' i wybierzemy moduł Kontakty

Kod-pod-obraz-1

Wszystkie definicje są umieszczone wewnątrz an API węzeł ze standardowym typem HTTP (get, post, put i delete). Ponieważ pobieramy dane z CRM, użyjemy wybierz węzły i przekazać nazwy modułów. Będziemy mieć pola, które trzeba będzie pobrać wewnątrz węzeł rekordów i wszelkie warunki filtrowania wewnątrz gdzie węzeł. Obsługujemy różne rodzaje Warunki jak równy, nie równy, podobny, większy niż, mniejszy niż itp.
Powyżej znajduje się prosty przykład, który można również osiągnąć za pomocą istniejącego pytanie REST API. Prawdziwa moc staje się widoczna, gdy połączysz wiele interfejsów API w jedno.
Rozważ ten przykład. Aktualizujesz rekord, jeśli istnieje, lub tworzysz, jeśli nie istnieje. Jeśli używasz istniejącego interfejsu API, do wykonania tych operacji będzie potrzebnych wiele wywołań. Ale korzystając z API Designer, możesz połączyć te operacje w jedno wywołanie interfejsu API.

Kod-pod-obraz-2

W powyższym przykładzie umieszczamy definicję wewnątrz upierać się węzeł. Obejmuje to aktualizacja i Stwórz węzeł, który zaktualizuje rekord, jeśli istnieje, lub utworzy rekord, jeśli nie istnieje. Aby zidentyfikować rekord, który wymaga aktualizacji, możesz użyć miejsca, w którym możesz filtrować i znaleźć odpowiednie wpisy. Na końcu definicji węzeł zwrotny odeśle zdefiniowane pola do klienta. Możesz zapisać i opublikować te interfejsy API, aby udostępnić je aplikacjom zewnętrznym, a także wewnętrznemu skryptowi JavaScript VTAP.

Uzyskiwanie dostępu do niestandardowego interfejsu API opublikowanego za pomocą API Designer
  • Aby uzyskać dostęp do dowolnego niestandardowego interfejsu API opublikowanego za pomocą API Designer, musisz użyć poniższego punktu końcowego.
  • https://your_instance.odx.vtiger.com/restapi/vtap/api/API_NAME?PARAMETRY?
  • API_NAME należy zastąpić nazwą nadaną API. Upewnij się również, że używasz odpowiedniego typu HTTP i kwalifikacje(nazwa użytkownika i klucz dostępu), aby uzyskać do niego dostęp.
Dostęp do niedawno utworzonego fetch_email_contact API przy użyciu listonosza
  • Aby uzyskać dostęp do ostatnio utworzonego fetch_email_contact API przy użyciu listonosza, powinieneś użyć poniższego.
  • https://your_instance.odx.vtiger.com/restapi/vtap/api/fetch_email_contact?domain=%vtiger.com%
Uwagi : https://twoja_instancja.odx.vtiger.com/restapi/v1/ApiDesigner/api/fetch_email_contact?domain=%vtiger.com% jest przestarzały.
Obraz podrzędny-3 (1)

Dostęp do tych interfejsów API można uzyskać wewnętrznie w Projektancie modułów za pomocą interfejsu VTAP Javascript API VTAP.CustomApi.Get do wyświetlania wewnątrz widżetu lub niestandardowych stron w interfejsie użytkownika Vtiger.

Kod-pod-obraz-3

Podsumowując, zobaczyliśmy, jak narzędzie API Designer umożliwia pisanie niestandardowych interfejsów API REST i używanie ich wewnętrznie oraz w innych aplikacjach do płynnego korzystania z danych CRM. W przypadku jakichkolwiek innych pytań, wyślij e-mail na adres [email chroniony] Zarejestruj się w wersji dla programistów tutaj.

tagi: , , , , , , , ,

Dasara - zdjęcie główne 3

Obchody i znaczenie Dasara w Indiach

Kto powiedział, że Indie nie mają sezonu wakacyjnego? Mamy jeden! Cicho dosłownie! Dla wielu z nas „sezon festiwalowy” trwa 2-3 miesiące…
Pozytywna kultura pracy

Pozytywna kultura pracy zwiększa produktywność

Kiedy praca, ludzie i środowisko powodują rozbieżności w twoim życiu, miejsce pracy jest określane jako toksyczne. Te zakłócenia mogą niekorzystnie wpłynąć na ...
Popraw komunikację 1

Jak poprawić komunikację biznesową dzięki integracji z CRM

Witamy z powrotem w serii blogów Cut-down Costs with CRM, gdzie będziemy omawiać wiele wymiarów redukcji kosztów za pomocą ...
Współpraca (1)

Jak korzystać z integracji CRM w celu płynnego prowadzenia działalności?

Witamy z powrotem w serii blogów Cut-down Costs with CRM, gdzie będziemy omawiać wiele wymiarów redukcji kosztów za pomocą ...
Transparent

Dlaczego kompetencje miękkie są ważne w miejscu pracy

John C był gwiazdą w pracy, często zdobywając nagrody i uznanie za swój wkład. Z biegiem czasu stał się zbyt pewny siebie. Jego przełożeni zauważyli, że...
Baner (2)

15 najczęstszych błędów, których należy unikać w miejscu pracy

Błędy zdarzają się wszędzie i każdemu, nawet w miejscu pracy. Bez względu na twoje doświadczenie, nieuchronnie popełnisz błąd lub dwa. . Nawet jeśli ...
Współpraca

Jak CRM pomaga we współpracy wewnętrznej i zewnętrznej

Witajcie ludzie! Witamy z powrotem w serii blogów Cut-down Costs with CRM, gdzie będziemy omawiać wiele wymiarów redukcji kosztów za pomocą ...
Scentralizowany baner informacji o kliencie

Jak scentralizowane dane w CRM mogą przynieść korzyści Twojej firmie

Witajcie ludzie! Witamy w serii blogów Cut-down Costs with CRM, gdzie będziemy omawiać wiele wymiarów redukcji kosztów za pomocą ...
Czat wewnętrzny Vtiger 2

Wykorzystaj wewnętrzny czat Vtiger do szybkiej współpracy zespołowej

Współpraca wewnętrzna jest niezbędna, aby pozostać w kontakcie ze współpracownikami i zwiększyć produktywność. Raport Businesswire stwierdza, że ​​71% pracowników czuje się bardziej produktywnych...
Działania — obraz funkcji

Użyj akcji w Vtiger, aby przyspieszyć swoje zadania

Uwielbiam terminy. Podoba mi się świszczący dźwięk, który wydają, gdy przelatują obok -Douglas Adams Terminy w środowisku biznesowym są ważne. Terminy...
załadunek
Prawa autorskie 2022 Vtiger | Polityka prywatności | Centrum zasad i prawa