Budowanie banera interfejsów API Rest (1)

Twój przewodnik po budowaniu interfejsów API REST


API oznacza interfejs programowania aplikacji. Każde oprogramowanie z określoną funkcją jest określane jako aplikacja podczas omawiania interfejsów API. Interfejs API można porównać do umowy serwisowej między dwoma programami, która określa żądania i odpowiedzi. Jeśli dopiero zaczynasz korzystać z interfejsów API, zalecamy zapoznanie się z naszymi Przewodnik po interfejsach API dla początkujących i Omówienie interfejsów API REST blog przed przeczytaniem tego.

Interfejsy API usług REST umożliwiają dostęp do danych CRM poprzez protokół HTTP/HTTPS. Możesz wykonywać czynności, takie jak tworzenie, aktualizowanie, pobieranie lub usuwanie operacji na dowolnych informacjach o rekordach CRM. Umożliwi to również przechowywanie danych konfiguracyjnych specyficznych dla rozszerzenia i użytkownika lub łączenie się z aplikacjami zewnętrznymi przy użyciu przechowywanych danych specyficznych dla rozszerzenia. Dostęp do wszystkich tych danych można uzyskać za pomocą podstawowej autoryzacji, czyli za pomocą nazwy użytkownika i klucza dostępu.

Tworzenie API REST

Poniżej przedstawiono pięć ogólnych kroków, których można użyć do zbudowania dowolnego interfejsu API:
  1. Zaplanuj interfejs API: wytyczne dotyczące projektowania interfejsu API można znaleźć w specyfikacjach interfejsu API, takich jak OpenAPI. Zaleca się wcześniejsze rozważenie różnych przypadków użycia i upewnienie się, że interfejs API jest zgodny z aktualnymi standardami programowania interfejsów API.
  2. Zbuduj interfejs API: Projektanci interfejsów API tworzą prototypy nowych interfejsów API z niewielką modyfikacją istniejących interfejsów API. Deweloperzy mogą dostosować prototyp do wymagań wewnętrznych po przejściu testów.
  3. Przetestuj interfejs API: Podobnie jak w przypadku testowania oprogramowania, testowanie API jest niezbędne do ochrony przed błędami i wadami. Przetestuj API pod kątem wytrzymałości na ataki online za pomocą narzędzi do testowania API.
  4. Udokumentuj interfejs API: chociaż interfejsy API nie wymagają wyjaśnień, dokumentacja może pomóc użytkownikom w łatwiejszy sposób. W architekturze zorientowanej na usługi częściej używane są dobrze udokumentowane interfejsy API z różnymi funkcjami i przypadkami użycia. Napisz dokument pomocy, aby udzielić wskazówek i pomóc innym w tworzeniu ich interfejsów API.
  5. Sprzedawaj API: Istnieją rynki internetowe, na których programiści mogą kupować i sprzedawać interfejsy API innym osobom, podobnie jak w przypadku towarów detalicznych w serwisie eBay, Amazon i Flipkart. Możesz zarabiać pieniądze na swoim interfejsie API, umieszczając go na liście.
Ten blog nauczy Cię, jak zbudować niestandardowe polecenie API REST za pomocą Projektanta API Vtiger. Więc zacznijmy.

Co to jest projektant API?

Projektant API to narzędzie lub programiści aplikacji, których mogą używać do tworzenia niestandardowych interfejsów API usług internetowych. Możesz zdefiniować niestandardowe punkty końcowe usługi i parametry zapytania. Tych interfejsów API można używać do interakcji z danymi CRM, integracji z aplikacjami zewnętrznymi, a także udostępniania tych danych interfejsom API Javascript VTAP, które mają być używane na niestandardowych stronach lub widżetach w interfejsie użytkownika Vtiger.

Możesz tworzyć interfejsy API przy użyciu języka projektowania aplikacji Vtiger (VADL), który jest luźno oparty na składni XML. VADL umożliwia administratorom lub programistom bez umiejętności programowania na wysokim poziomie łatwe definiowanie interfejsów API, ale mając podstawową wiedzę na temat programowania, można szybko tworzyć skuteczne interfejsy API.

Interfejsy API REST są zgodne ze standardowym protokołem REST API i można zdefiniować ich punkty końcowe w następujący sposób:
https://instance.odx.vtiger.com/restapi/vtap/api/YOUR_CUSTOM_API_PATH

W przypadku interfejsu API REST obsługiwane są następujące metody żądania HTTP:
  • GET
  • POST
  • PUT
  • DELETE
Zobaczmy, jak możesz użyć VTAP do zbudowania niestandardowego interfejsu API REST.

Użytkownicy Vtiger CRM mogą budować interfejsy API REST, które będą łączyć CRM z innymi aplikacjami innych firm lub tworzyć nowe, które rozszerzą funkcjonalność CRM. Oto przykład:

Stwórzmy REST API, które to potrafi dostęp do danych z specyficzny moduł za pomocą VTAP.

Poniżej przedstawiono przykład API, które pobiera dane z modułu CRM tzw Organizacje aby wyświetlić pięć najlepszych organizacji o najwyższych rocznych przychodach z nazwą interfejsu API jako najlepsze_organizacje. Możesz wybrać inną nazwę, aby zachować jej unikalność.

Zanim zaczniemy, zapoznajmy się z komponentami XML i VDAL, które zostaną użyte do zdefiniowania akcji w powyższym przykładzie API.

W poniższej tabeli opisano składniki XML i VDAL, które będą używane do definiowania niestandardowego interfejsu API REST w celu uzyskiwania dostępu do danych programu CRM i ich wyświetlania:
Składnik XML i VDAL Działania
metoda interfejsu API = „pobierz” Definiowanie metody żądania HTTP
wybierz moduł = „Rachunki” Zdefiniuj moduł, z którego chcesz pobrać dane wybierać
nazwa pola rekordu = „nazwa konta”> Zdefiniuj pola w rekordzie, z których mają zostać pobrane dane rekord
nazwa pola sortowania=”przychód_roczny” order=”malejąco” /field /sort Zdefiniuj warunki wyniku tabeli za pomocą rodzaj
limit max=”5″ strona=”@strona” /limit Zdefiniuj liczbę szczegółów rekordu, które mają być wyświetlane za pomocą ograniczenie
/wybierz /api Zakończ zamknięciem wszystkich otwartych tagów
Uwagi że wszystkie komponenty XML i VDAL w powyższej tabeli mają być ujęte w znaczniki (<>).

Wykonaj następujące kroki, aby zbudować omówiony powyżej interfejs API REST:
  1. Zaloguj się do swojego konta Vtiger CRM.
  2. Kliknij Menu główne.
  3. Kliknij Platforma.
  4. Wybierz Projektant API.
  5. Kliknij + Dodaj interfejs API.

  6. image1
  7. Kliknij Stwórz obok REST API. Zostanie otwarte okno Dodaj interfejs API REST.

  8. image4
  9. Dodaj interfejs API REST: Wprowadź lub wybierz informacje dla następujących elementów:
    1. Moduł: Wybierz moduł CRM, z którego chcesz uzyskać dostęp do danych.
    2. Imię lub Nazwa Firmy: Wprowadź unikalny identyfikator interfejsu API.
    3. status: Kliknij pole wyboru, aby aktywować interfejs API.
  10. Kliknij Zapisz.

  11. image2
  12. Po dodaniu interfejsu API zobaczysz wbudowane IDE, w którym będziesz używać VADL do definiowania interfejsów API i węzłów XML w celu pobierania danych CRM. Zapoznaj się z powyższą tabelą, aby zrozumieć składniki XML i VADL.

  13. image3
  14. Kliknij Zapisz i opublikuj opublikować zbudowany interfejs API.
Możesz uzyskać dostęp do powyższego interfejsu API REST i przetestować go z dowolnej aplikacji zewnętrznej, korzystając z następującego adresu URL.
https://instance.odx.vtiger.com/restapi/vtap/api/top_organizations

Uwagi że powyższy adres URL jest przykładowy i będziesz musiał zdefiniować punkt końcowy zgodnie z instancją CRM.

Czy wiesz? Powyższe dane można wykorzystać do wyświetlenia listy na niestandardowej stronie lub wykresu słupkowego i innych dynamicznych wyników przy użyciu komponentów javascript do zdefiniowania interfejsów API. Dostęp do wszystkich niestandardowych interfejsów API REST wbudowanych w projektancie API można również uzyskać za pomocą API JavaScript VTAP.

Aby dowiedzieć się więcej o tworzeniu niestandardowych interfejsów API i VTAP, sprawdź Dokumentacja VTAP.

Prawa autorskie 2023 Vtiger | Prywatności | Centrum zasad i prawa