Wyświetlasz dokumentację Apigee Edge.
Przejdź do
dokumentacji Apigee X. info
Apigee Edge to platforma do tworzenia interfejsów API i zarządzania nimi. Dzięki warstwie proxy przed usługami Edge zapewnia abstrakcję lub fasadę dla interfejsów API usług backendu oraz zabezpieczenia, ograniczanie liczby żądań, limity, statystyki i inne funkcje.
Możesz na przykład obejrzeć webcast o tym, jak Walgreens używa interfejsów API i Apigee Edge do tworzenia bogatego ekosystemu aplikacji związanych z drukowaniem zdjęć, receptami i innymi usługami.
Przyspieszenie cyfrowe
Z tego filmu dowiesz się, jak Apigee pomaga przekształcić Twoją firmę w przedsiębiorstwo cyfrowe.
Wybór między zarządzaniem usługami a zarządzaniem interfejsami API
Z tego filmu dowiesz się, jakie są najważniejsze różnice między zarządzaniem usługami a zarządzaniem interfejsami API. firmy.
Udostępnianie usług w internecie
Firmy chcą obecnie udostępniać swoje usługi backendu w internecie, aby mogły z nich korzystać aplikacje działające na urządzeniach mobilnych i komputerach. Firma może chcieć udostępnić usługi, które zawierają informacje o cenach i dostępności produktów, usługi sprzedaży i zamawiania usługi, usługi śledzenia zamówień oraz inne usługi wymagane przez aplikacje klienckie.
Firmy często udostępniają usługi jako zestaw punktów końcowych HTTP. Deweloperzy aplikacji klienckich wysyłają następnie żądania HTTP do tych punktów końcowych. W zależności od punktu końcowego usługa może następnie zwrócić dane w formacie XML lub JSON do aplikacji klienckiej.
Aplikacje klienckie, które korzystają z tych usług, mogą być implementowane jako samodzielne aplikacje na urządzenia mobilne lub tablety, jako aplikacje HTML5 działające w przeglądarce lub jako dowolny inny typ aplikacji, która może wysyłać żądania do punktu końcowego HTTP i korzystać z danych odpowiedzi. Aplikacje te mogą być tworzone i publikowane przez tę samą firmę, która udostępniła usługi, lub przez deweloperów aplikacji innych firm, którzy korzystają z publicznie dostępnych usług.
Poniższy obraz przedstawia ten typ modelu:
Ponieważ dostawcy udostępniają swoje usługi w internecie, muszą się upewnić, że podjęli wszystkie niezbędne kroki, aby zabezpieczyć swoje usługi i chronić je przed nieautoryzowanym dostępem. Jako usługodawca rozważ:
- Bezpieczeństwo: jak będziesz kontrolować dostęp do swoich usług, aby zapobiec nieautoryzowanemu dostępowi?
- Zgodność: czy Twoje usługi będą działać na różnych platformach i urządzeniach?
- Mierzalność: jak możesz monitorować swoje usługi, aby mieć pewność, że są dostępne?
- Zarabianie: jak możesz śledzić i rozliczać klientów za dostęp do swoich usług?
- I wiele innych kwestii.
Po opublikowaniu aplikacji klienckiej, która uzyskuje dostęp do dowolnych usług, usługodawca jest następnie zobowiązany upewnić się, że usługi te będą nadal działać w miarę dodawania, modyfikowania lub usuwania tych usług. Usługodawca musi też mieć możliwość informowania deweloperów aplikacji o wszelkich zmianach w usługach, aby aplikacje klienckie były z nimi zsynchronizowane.
Deweloperzy aplikacji klienckich napotykają trudności podczas korzystania z usług różnych dostawców. Obecnie dostępnych jest wiele technologii, których usługodawca może używać do udostępniania swoich usług. Ta sama aplikacja kliencka może używać jednego mechanizmu do korzystania z usługi jednego dostawcy i innego mechanizmu do korzystania z usługi innego dostawcy. Deweloperzy aplikacji mogą nawet znaleźć się w sytuacji, w której muszą używać różnych mechanizmów do korzystania z usług tego samego dostawcy.
Udostępnianie usług za pomocą Apigee Edge
Apigee Edge umożliwia bezpieczny dostęp do usług za pomocą dobrze zdefiniowanego interfejsu API, który jest spójny we wszystkich usługach, niezależnie od implementacji usługi. Spójny interfejs API:
- ułatwia deweloperom aplikacji korzystanie z Twoich usług;
- umożliwia zmianę implementacji usługi backendu bez wpływu na publiczny interfejs API;
- umożliwia korzystanie ze statystyk, zarabiania, portalu dla programistów i innych funkcji wbudowanych w Edge.
Poniższy obraz przedstawia architekturę, w której Edge obsługuje żądania z aplikacji klienckich do usług backendu:
Zamiast korzystać z Twoich usług bezpośrednio, deweloperzy aplikacji uzyskują dostęp do proxy interfejsu API utworzonego w Edge. Proxy interfejsu API działa jako mapowanie publicznie dostępnego punktu końcowego HTTP na usługę backendu. Tworząc proxy interfejsu API, umożliwiasz Edge obsługę zadań związanych z bezpieczeństwem i autoryzacją wymaganych do ochrony Twoich usług, a także do analizowania, monitorowania i zarabiania na tych usługach.
Ponieważ deweloperzy aplikacji wysyłają żądania HTTP do proxy interfejsu API, a nie bezpośrednio do Twoich usług, nie muszą znać implementacji Twoich usług. Deweloper musi tylko wiedzieć:
- adres URL punktu końcowego proxy interfejsu API;
- wszystkie parametry zapytania, nagłówki lub parametry treści przekazywane w żądaniu;
- wszystkie wymagane dane uwierzytelniające i autoryzacyjne;
- format odpowiedzi, w tym format danych odpowiedzi, np. XML lub JSON.
Proxy interfejsu API izoluje dewelopera aplikacji od usługi backendu. Dlatego możesz swobodnie zmieniać implementację usługi, o ile publiczny interfejs API pozostanie spójny. Dzięki zachowaniu spójności interfejsu API frontendowego istniejące aplikacje klienckie będą nadal działać niezależnie od zmian w backendzie.
Możesz używać zasad w proxy interfejsu API, aby dodawać funkcje do usługi bez konieczności wprowadzania zmian w usłudze backendu. Możesz na przykład dodać do proxy zasady, które będą wykonywać transformacje i filtrowanie danych, dodawać zabezpieczenia, wykonywać logikę warunkową lub kod niestandardowy oraz wykonywać wiele innych działań. Pamiętaj, że zasady implementujesz w Edge, a nie na serwerze backendu.
Więcej informacji znajdziesz w artykule Omówienie interfejsów API i proxy interfejsów API.
Tworzenie usługi API
Proxy interfejsu API to punkt końcowy HTTP w Apigee Edge, którego deweloperzy używają do uzyskiwania dostępu do usług backendu. Chociaż jest to możliwe, zwykle nie udostępniasz poszczególnych proxy interfejsów API. Zamiast tego grupujesz co najmniej 1 proxy interfejsu API w usługę API.
Usługa API to pakiet proxy interfejsów API połączony z planem usług. Ten plan usług może ustawiać limity dostępu do proxy interfejsów API, zapewniać bezpieczeństwo, umożliwiać monitorowanie i analizowanie oraz udostępniać dodatkowe funkcje. Usługi API są też głównym mechanizmem, którego Edge używa do autoryzacji i kontroli dostępu do interfejsów API.
Podczas tworzenia usług API masz dużą elastyczność. Na przykład kilka usług API może współdzielić to samo proxy interfejsu API. Na ilustracji poniżej przedstawiono 3 usługi API. Zwróć uwagę, że wszystkie produkty umożliwiają dostęp do proxy interfejsu API 3, ale tylko produkt A umożliwia dostęp do proxy interfejsu API 1.
W każdej usłudze API możesz ustawić inne właściwości. Możesz na przykład udostępnić usługę API z niskim limitem dostępu, np. 1000 żądań dziennie, w atrakcyjnej cenie. Następnie możesz opublikować inną usługę API, która zapewnia dostęp do tego samego proxy interfejsu API, ale z dużo wyższym limitem dostępu, w wyższej cenie. Możesz też utworzyć bezpłatną usługę API, która umożliwia dostęp tylko do odczytu do Twoich usług, a następnie sprzedawać usługę API do tych samych proxy interfejsów API, która umożliwia dostęp do odczytu i zapisu.
Więcej informacji znajdziesz w artykule Zarządzanie usługami API produktów.
Zezwalanie aplikacji po stronie klienta na dostęp do usługi API
Gdy deweloperzy aplikacji zdecydują, że chcą uzyskać dostęp do Twoich usług, muszą najpierw zarejestrować swoją aplikację kliencką w Twojej usłudze API.
Po rejestracji deweloper aplikacji otrzymuje klucz interfejsu API, który musi dołączyć do każdego żądania wysyłanego do proxy interfejsu API zawartego w usłudze API. Klucz jest uwierzytelniany, a jeśli uwierzytelnianie się powiedzie, żądanie może uzyskać dostęp do usługi backendu.
W każdej chwili możesz cofnąć klucz, aby aplikacja kliencka nie miała już dostępu do Twoich usług. Możesz też określić limit czasu dla klucza, aby deweloper musiał go odświeżyć po określonym czasie.
Ty decydujesz, jak obsługiwać żądania rejestracji od deweloperów, którzy chcą uzyskać dostęp do Twoich usług API. Korzystając z usług dla deweloperów Apigee Edge, możesz zautomatyzować proces rejestracji lub użyć procesu ręcznego, aby kontrolować dostęp.
Tworzenie usług API i udostępnianie ich deweloperom
- Utwórz co najmniej 1 proxy interfejsu API, które mapuje publicznie dostępne adresy URL na Twoje usługi backendu.
- Utwórz usługę API, która zawiera Twoje proxy interfejsów API.
- Wdróż proxy interfejsu API i usługę API.
- Poinformuj deweloperów, że usługa API jest dostępna.
Gdy deweloperzy aplikacji dowiedzą się o dostępności Twojej usługi API:
- zarejestrują swoje aplikacje klienckie w Twojej usłudze API;
- otrzymają klucz interfejsu API dla usługi API;
- będą wysyłać żądania do Twoich usług za pomocą proxy interfejsów API (które są zawarte w usłudze API) i przekazywać klucz interfejsu API z każdym żądaniem.
Komponenty Apigee Edge
Apigee Edge składa się z środowiska wykonawczego interfejsu API, monitorowania i statystyk oraz usług dla deweloperów, które razem zapewniają kompleksową infrastrukturę do tworzenia, zabezpieczania, zarządzania, i obsługi interfejsów API.
Na ilustracji poniżej przedstawiono usługi Edge:
Środowisko wykonawcze interfejsu Edge API
Usługi Apigee Edge API służą do tworzenia i korzystania z interfejsów API, niezależnie od tego, czy tworzysz proxy interfejsów API jako usługodawca, czy używasz interfejsów API, pakietów SDK i innych usług ułatwiających pracę jako deweloper aplikacji.
Serwer zarządzania interfejsami API udostępnia narzędzia do dodawania i konfigurowania proxy interfejsów API, konfigurowania usług API oraz zarządzania deweloperami aplikacji i aplikacjami klienckimi. Odciąża on usługi backendu od wielu typowych zadań związanych z zarządzaniem. Gdy dodasz proxy interfejsu API, możesz zastosować do niego zasady, aby dodać zabezpieczenia, ograniczyć liczbę żądań, pośredniczyć, buforować, itp. Możesz też dostosować działanie proxy interfejsu API, stosując skrypty niestandardowe, wywołując interfejsy API i usługi innych firm itp. Więcej informacji znajdziesz w artykule Omówienie interfejsów API i proxy interfejsów API.
Jeśli jesteś deweloperem Node.js, możesz bezproblemowo dodawać moduły Node.js do Edge, aby tworzyć interfejsy API i mashupy interfejsów API, korzystając jednocześnie z zalet Edge, od transformacji wiadomości po zabezpieczenia i statystyki.
Monitorowanie i statystyki Edge
Apigee Edge API Analytics udostępnia zaawansowane narzędzia do analizowania krótkoterminowych i długoterminowych trendów wykorzystania interfejsów API. Możesz segmentować odbiorców według najlepszych deweloperów i aplikacji, analizować wykorzystanie według metody interfejsu API, aby wiedzieć, gdzie inwestować, oraz tworzyć niestandardowe raporty zawierające informacje na poziomie biznesowym lub operacyjnym.
Gdy dane przechodzą przez Edge, zbierane są różne domyślne typy informacji, w tym adres URL, adres IP, identyfikator użytkownika w przypadku informacji o wywołaniu interfejsu API, opóźnienie, dane o błędach itp. Możesz tworzyć zasady, aby dodawać inne informacje, takie jak nagłówki, parametry zapytania i fragmenty żądania lub odpowiedzi wyodrębnione z XML lub JSON. Informacje te są zbierane asynchronicznie z rzeczywistego przepływu żądania/odpowiedzi, dlatego nie mają wpływu na wydajność interfejsu API.
Interfejs zarządzania umożliwia wyświetlanie wielu wskaźników i wymiarów w przeglądarce, jak pokazano na ilustracji poniżej:
Możesz jednak uzyskiwać dostęp do usługi Analytics i nią sterować za pomocą interfejsu wiersza poleceń lub interfejsów API typu REST. Więcej informacji znajdziesz w artykule Omówienie statystyk interfejsu API.
Ekosystem deweloperów Edge
Apigee Edge udostępnia usługi dla deweloperów, które umożliwiają:
- zarządzanie społecznością deweloperów aplikacji, którzy korzystają z Twoich usług;
- współpracę z deweloperami wewnętrznymi i zewnętrznymi oraz formalizowanie relacji za pomocą modeli finansowych;
- wprowadzanie programistów i tworzenie portalu dla programistów. Deweloperzy aplikacji łączą się z Twoim portalem, aby uzyskać dostęp do dokumentacji interfejsu API, dowiedzieć się więcej o publicznie dostępnych usługach API i zarządzać kluczami interfejsu API.
Każdy klient Edge może utworzyć własny portal dla programistów w chmurze lub lokalnie za pomocą Apigee Edge for Private Cloud.
Apigee Edge umożliwia tworzenie 2 typów portali:
- Zintegrowany portal , który można natychmiast udostępnić. Zobacz Tworzenie zintegrowanego portalu.
- Portal oparty na Drupalu. Zobacz Tworzenie portalu opartego na Drupalu.
Zarabianie
Funkcje zarabiania zapewniają infrastrukturę finansową i relacje, które pozwalają przekształcić Twoją społeczność deweloperów w rzeczywisty kanał dla Twoich zasobów cyfrowych. Dzięki zarabianiu możesz tworzyć różne plany taryfowe, które obciążają deweloperów za korzystanie z Twoich usług API lub umożliwiają płacenie deweloperom w scenariuszach dzielenia się przychodami.
Plany obejmują plany przedpłacone, plany płatne, plany z opłatą stałą, plany ze stawką zmienną, plany „freemium”, plany dostosowane do konkretnych deweloperów, plany obejmujące grupy deweloperów i inne. Zarabianie obejmuje też funkcje raportowania i rozliczeń.
Więcej informacji znajdziesz w artykule Omówienie zarabiania.
Wersje Edge
Apigee Edge jest dostępny w tych wersjach:
- Chmura publiczna: hostowana wersja SAAS, w której Apigee utrzymuje środowisko, co pozwala Ci skupić się na tworzeniu usług i definiowaniu interfejsów API dla tych usług.
- Chmura prywatna: instalacja lokalna, w której kontrolujesz środowisko sprzętowe i odpowiadasz za instalację, aktualizację, konserwację i inne procesy administracyjne.
Jeśli interesuje Cię nasza wersja Apigee hybrid, zapoznaj się z tymi tematami Apigee X:
Pod względem funkcjonalności wersje chmury publicznej i chmury prywatnej są bardzo podobne. Jednak wersja chmury prywatnej nie obsługuje wszystkich funkcji wersji chmury publicznej. Funkcje nieobsługiwane przez chmurę prywatną:
- Hostowane lokalizacje docelowe
- Rozszerzenia
- Zintegrowane portale dla deweloperów (Uwaga: portale dla deweloperów oparte na Drupalu są obsługiwane)
- Monitorowanie interfejsów API
- Sense
Listę różnic między wersjami znajdziesz w artykule Porównanie usług Apigee.
Istnieją też drobne różnice między interfejsami API, które opisano w artykule Różnice między interfejsami Edge for Public Cloud API i Private Cloud API.
Chmura publiczna obsługuje konta bezpłatne i płatne. Chmura prywatna wymaga kont płatnych.
Aby w pełni obsługiwać instalację lokalną, wersja chmury prywatnej zawiera komponenty takie jak serwer zarządzania Apigee, baza danych Apache Cassandra NoSQL, serwer OpenLDAP, router wiadomości i procesor komunikatów.