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 zapewnia 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
Na tym blogu omówię, w jaki sposób możemy stworzyć niestandardowe API REST.
Najpierw pozwól mi trochę porozmawiać 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 Twojej instancji 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.
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ą WADL specyfikacje.
Dostęp API wymaga autoryzacji użytkownika i odbywa się zgodnie ze standardową konfiguracją dostępu do rekordów w ramach CRM.
Projektant API zapewnia IDE do pisania niestandardowych interfejsów API. Jeśli piszesz niestandardowy interfejs API REST dla określonego modułu, musisz nazwać interfejs API i wybrać moduł.
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.
WADL 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
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.
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ć opcji gdzie filtrować i znajdować odpowiednie wpisy. Na koniec 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, jak również wewnętrznemu 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/NAZWA_API?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%
Note : https://twoja_instancja.odx.vtiger.com/restapi/v1/ApiDesigner/api/fetch_email_contact?domain=%vtiger.com% jest przestarzały.
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.
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 w celu bezproblemowego 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.
