Basic terminology

Interfejs programowania aplikacji – interfejs, który ułatwia jednej aplikacji korzystanie z funkcji lub danych innej aplikacji.

Dzięki definiowaniu stabilnych, uproszczonych punktów wejścia do logiki i danych aplikacji interfejsy API umożliwiają programistom łatwy dostęp do logiki aplikacji utworzonej przez innych programistów i jej ponowne wykorzystanie. W przypadku interfejsów API sieci ta logika i dane są udostępniane w sieci. Ponieważ aplikacje korzystające z interfejsów API są wrażliwe na zmiany, interfejsy API implikują również umowę. Umowa zapewnia pewien poziom pewności, że z czasem interfejs API będzie się zmieniać w przewidywalny sposób.

Apigee udostępnia wiele informacji o interfejsach API i sprawdzonych metodach ich tworzenia i używania. Aby rozpocząć, obejrzyj webcast API Design lub pobierz bezpłatny e-book Web API Design: The Missing Link Best Practices for Crafting Interfaces that Developers Love.

Fasada w Edge dla co najmniej 1 interfejsu API, ogólnych usług HTTP lub aplikacji (np. Node.js).

Proxy interfejsu API jest implementowane jako zestaw plików konfiguracyjnych, zasad i kodu, które korzystają z zestawu zasobów udostępnianych przez Apigee Edge. Proxy interfejsu API można generować i konfigurować za pomocą interfejsu zarządzania Apigee Edge lub implementować lokalnie w edytorze tekstu lub IDE.

Fasada udostępniana przez proxy interfejsu API oddziela interfejs API widoczny dla programistów od backendu usług, chroniąc programistów przed zmianami kodu i umożliwiając innowacje na brzegu sieci bez wpływu na wewnętrzne zespoły programistów. Gdy zespoły programistów wprowadzają zmiany w backendzie, programiści nadal mogą bez przeszkód wywoływać ten sam interfejs. Apigee umożliwia udostępnianie wielu interfejsów do tego samego interfejsu API, co pozwala dostosować sygnaturę interfejsu API do potrzeb różnych grup programistów.

Interfejsy API zdefiniowane przez adresy sieciowe i identyfikatory URI. Interfejs API składa się z podstawowej ścieżki i zestawu zasobów interfejsu API. Każdy proxy interfejsu API definiuje podstawową ścieżkę i opcjonalnie, wiele ścieżek zasobów interfejsu API. Interfejs API można traktować jako zestaw identyfikatorów URI, które mają wspólną podstawową ścieżkę.

Aby ułatwić zarządzanie interfejsami API, Apigee rozszerza te surowe identyfikatory URI o nazwy wyświetlane i opisy. Edge umożliwia dołączanie zasad i kodu do identyfikatorów URI, co pozwala na precyzyjną kontrolę i zarządzanie zachowaniem interfejsów API.

Zbiór zasobów interfejsu API (identyfikatorów URI) połączonych z limitem lub planem usługi, który jest publikowany dla programistów aplikacji w czasie projektowania. Usługi API można z kolei łączyć w pakiety API w celu zarabiania.

Klucz interfejsu API jest powiązany z co najmniej 1 usługą API, co wymusza powiązanie między aplikacją a pakietem identyfikatorów URI, z których aplikacja może korzystać.

Skrót od aplikacja. Określenie aplikacja zaczęło odnosić się do aplikacji mobilnych które korzystają z interfejsów API. Programiści implementują aplikacje w różnych językach programowania oraz przy użyciu różnych technologii i platform. Programiści, którzy chcą korzystać z interfejsów API, rejestrują aplikacje w organizacji dostawcy interfejsu API w Apigee Edge.

Gdy aplikacja jest zarejestrowana, Apigee generuje klucz interfejsu API i klucz tajny, które identyfikują aplikację. Programista umieszcza klucz interfejsu API w aplikacji, która przedstawia klucz podczas wysyłania żądań. Usługi API implementują zabezpieczenia wokół klucza interfejsu API za pomocą bezpośredniej weryfikacji klucza interfejsu API lub OAuth.

Kontekst wykonania środowiska wykonawczego dla proxy interfejsu API. Aby interfejs API udostępniany przez proxy interfejsu API był dostępny w sieci, proxy interfejsu API musi zostać wdrożone w środowisku. Domyślnie, organizacje są wyposażone w 2 środowiska: testowe i produkcyjne.

• Środowisko testowe jest zwykle używane do wdrażania proxy interfejsu API podczas programowania.
• Środowisko produkcyjne jest zwykle używane do promowania proxy interfejsu API ze środowiska testowego środowiska po ich pełnym opracowaniu i przetestowaniu.

Kontener na wszystkie obiekty na koncie Apigee Edge, w tym proxy interfejsu API, usługi API , pakiety API, aplikacje i programistów.

W przypadku każdej organizacji, której jesteś członkiem, wymagane jest konto użytkownika. (Większość użytkowników ma konto tylko w 1 organizacji).

Krok przetwarzania, który jest wykonywany jako niepodzielna, wielokrotnego użytku jednostka logiki w ramach przepływu przetwarzania proxy interfejsu API

Typowe funkcje oparte na zasadach obejmują m.in. przekształcanie formatów wiadomości, egzekwowanie kontroli dostępu, wywoływanie usług zdalnych w celu uzyskania dodatkowych informacji, maskowanie danych wrażliwych przed użytkownikami zewnętrznymi, sprawdzanie treści wiadomości pod kątem potencjalnych zagrożeń, buforowanie typowych odpowiedzi w celu zwiększenia wydajności itp.

Zasady mogą być wykonywane warunkowo na podstawie treści lub kontekstu żądania lub odpowiedzi. Na przykład zasada przekształcania może zostać wykonana w celu dostosowania formatu odpowiedzi, jeśli wiadomość z żądaniem została wysłana ze smartfona.

Wersja interfejsu API widocznego dla programistów.

Na przykład pivotaltracker.com/services/v3 lub api.enterprise.apigee.com/v1.

To określenie różni się od wersji, która jest numerowanym, kontrolowanym przez wersję pakietem konfiguracji i zasad dołączonym do proxy interfejsu API. Interfejsy API mają wersje, a proxy interfejsu API – wersje.