Wyświetlasz dokumentację Apigee Edge.
Przejdź do
dokumentacji Apigee X. info
W Apigee występuje kilka pojęć, które są powszechne, ale mają unikalne znaczenie.
| Określenie | Definicja |
|---|---|
| Interfejs API | Proxy, które działa jako fasada dla istniejącego interfejsu API. Zamiast wywoływać istniejący interfejs API, deweloperzy zaczynają wywoływać nowy interfejs API wygenerowany przez Apigee. Ta fasada oddziela interfejs publiczny od interfejsu API backendu, chroniąc deweloperów przed zmianami w backendzie i umożliwiając wprowadzanie innowacji na brzegu sieci bez wpływu na wewnętrzne zespoły deweloperów. Gdy wprowadzasz zmiany w backendzie, deweloperzy nadal wywołują ten sam interfejs API bez przerw. W bardziej zaawansowanych scenariuszach Apigee umożliwia udostępnianie wielu interfejsów do tego samego interfejsu API, co pozwala dostosować sygnaturę interfejsu API do potrzeb różnych grup deweloperów. |
| Podstawowa ścieżka i zasoby interfejsu API | Interfejs API składa się z podstawowej ścieżki i zestawu zasobów (znanych też jako ścieżki zasobów). Dla każdego interfejsu API definiujesz jeden główny adres URL i wiele ścieżek zasobów. Interfejs API można traktować jako zestaw identyfikatorów URI, które mają wspólną ścieżkę podstawową. Aby ułatwić zarządzanie interfejsami API, Apigee rozszerza te surowe identyfikatory URI o wyświetlane nazwy i opisy. |
| Użytkownik interfejsu API | Synonim „dewelopera aplikacji”, który używa interfejsów API utworzonych przez dostawcę interfejsu API. |
| Programista interfejsu API | Inżynier oprogramowania w organizacji dostawcy interfejsu API, który tworzy interfejsy API. Te interfejsy API są używane przez deweloperów aplikacji (użytkowników interfejsu API) do tworzenia aplikacji. |
| Pakiet interfejsu API | Zbiór usług API, które są prezentowane deweloperom jako pakiet i zwykle powiązane z planem taryfowym. |
| Usługa API | Zbiór zasobów interfejsu API (identyfikatorów URI) połączonych z planem usług i prezentowanych deweloperom jako pakiet. Usługa API może też zawierać metadane specyficzne dla Twojej firmy, które służą do monitorowania lub analizy. Jeden lub więcej zasobów można spieniężyć, dodając je do usługi API, którą można następnie spakować w pakiet interfejsu API w celu spieniężenia. |
| Dostawca interfejsu API | Dostawca interfejsu API tworzy interfejsy API (za pomocą Edge), z których mogą korzystać użytkownicy interfejsu API (deweloperzy aplikacji). |
| Programista aplikacji | W Edge deweloperzy aplikacji rejestrują swoje aplikacje u dostawcy interfejsu API. W ten sposób deweloperzy aplikacji uzyskują klucze interfejsu API potrzebne do wywoływania proxy interfejsu API dostawcy. |
| Aplikacje | Deweloperzy używają aplikacji, aby uzyskiwać dostęp do zasobów w Twoich usługach API. Gdy tworzysz aplikację, wybierasz usługę API, którą chcesz uwzględnić, a Apigee generuje klucz. Każda aplikacja ma jeden klucz, który zapewnia dostęp do wielu usług API. Aplikacje pozwalają kontrolować, kto może uzyskiwać dostęp do Twoich zasobów. Możesz kontrolować, kto ma dostęp do Twoich usług API, odwołując i odświeżając klucz aplikacji. Możesz też kontrolować dostęp do pakietów zasobów, odwołując lub usuwając dostęp do usług w aplikacji. |
| Szczegóły salda | W przypadku dewelopera korzystającego z przedpłaty saldo na jego koncie. |
| Zamknięta korekta | Korekta, która została zastosowana w opublikowanych dokumentach rozliczeniowych. |
| Zamknięty miesiąc rozliczeniowy | Pełny miesiąc kalendarzowy, za który opublikowano dokumenty rozliczeniowe. |
| Limit niestandardowy | Limit (np. limit liczby transakcji w usłudze API), który możesz wyraźnie ustawić za pomocą funkcji zarabiania. Nazywany też limitem jawnym. |
| Plan taryfowy dla kategorii deweloperów | Plan taryfowy, który obowiązuje wszystkich deweloperów w określonej kategorii i jest dostępny do zakupu przez wszystkich deweloperów w tej kategorii. |
| Plan taryfowy dla dewelopera | Plan taryfowy, który obowiązuje konkretnego dewelopera i jest dostępny do zakupu tylko przez tego dewelopera. |
| Agent ujawniony | W prawie handlowym osoba upoważniona do działania w imieniu innej osoby (zwanej mocodawcą) w celu nawiązania stosunku prawnego z osobą trzecią. W przypadku zarabiania można skonfigurować model podatkowy dla planu dzielenia się przychodami, tak aby dostawca interfejsu API działał jako ujawniony agent dewelopera, który pobiera przychody (i ewentualnie podatek od sprzedaży) w imieniu dewelopera. |
| Ujawniony model podatkowy | Model podatkowy, w którym dostawca interfejsu API działa jako ujawniony agent dewelopera. |
| Środowisko | Kontekst wykonania interfejsów API w czasie działania. Aby można było uzyskać dostęp do interfejsu API w czasie działania, musi on zostać wdrożony w środowisku przed nim. Domyślnie organizacje Apigee są udostępniane z 2 środowiskami: „test” i „prod”. Środowisko „test” jest zwykle używane do wdrażania interfejsów API, które są testowane. Środowisko „prod” jest zwykle używane do wdrażania interfejsów API do użytku produkcyjnego. |
| Hybrydowy model podatkowy | Model podatkowy, w którym dostawca interfejsu API działa jako ujawniony agent dewelopera. Dostawca interfejsu API płaci jednak podatek od sprzedaży pobrany od subskrybentów lokalnym organom podatkowym w imieniu dewelopera. |
| Limit domyślny | Limit (np. limit salda z przedpłaty dewelopera) ustawiony przez funkcję zarabiania. |
| Zarabianie | Komponent usług dla deweloperów Apigee Edge, który zapewnia łatwy w użyciu i elastyczny sposób zarabiania na usługach API. |
| Wykorzystana kwota miesięczna | Łączne wykorzystanie dewelopera w danym miesiącu, które obejmuje opłatę konfiguracyjną + opłatę transakcyjną + opłatę cykliczną. |
| Płatności miesięczne | Płatności cykliczne dokonywane przez dewelopera na podstawie zakupionych abonamentów. Plany taryfowe mogą obejmować opłatę cykliczną, która jest naliczana deweloperowi co miesiąc niezależnie od wykorzystania. |
| Zestawienie rozliczeń | Dokument finansowy, który pokazuje salda netto między fakturami a zestawieniami udziału w przychodach. |
| Otwarta korekta | Korekta, która nie została jeszcze zastosowana w opublikowanych dokumentach rozliczeniowych. |
| Otwarty miesiąc rozliczeniowy | Pełny miesiąc kalendarzowy, za który nie opublikowano „ostatecznych” dokumentów rozliczeniowych. |
| Organizacja | Kontener wszystkich obiektów na koncie Apigee, w tym interfejsów API, usług API, pakietów interfejsów API, aplikacji i deweloperów. Do każdej organizacji, której jesteś członkiem, musisz mieć konto użytkownika. (Większość użytkowników ma konto tylko w 1 organizacji). Do każdego przesyłanego żądania do interfejsu API musisz podać swoje dane logowania (nazwę użytkownika i hasło) oraz nazwę organizacji. |
| Katalog pakietów | Lista pakietów interfejsów API. Każdy pakiet jest wymieniony wraz z usługami API i planami taryfowymi. |
| Saldo z przedpłaty | Kwota dostępna dla dewelopera korzystającego z przedpłaty, która umożliwia mu płacenie z góry za pakiety interfejsów API. |
| Deweloper korzystający z przedpłaty | Deweloper, który płaci z góry za korzystanie z usługi API. Środki są potrącane z salda dewelopera korzystającego z przedpłaty, gdy używana jest usługa API. Deweloper musi mieć saldo z przedpłaty wystarczające do zakupu usługi API. Dostawca interfejsu API przypisuje deweloperom status przedpłaty lub płatności po wykonaniu usługi. |
| Zasada | Krok przetwarzania, który jest wykonywany jako niepodzielna, wielokrotnego użytku jednostka logiki w ramach przepływu interfejsu API. Typowe zasady obejmują kierowanie żądań do właściwego punktu końcowego, przekształcanie formatu 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 zawartoś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 albo 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. |
| Deweloper korzystający z płatności po wykonaniu usługi | Deweloper, który otrzymuje co miesiąc fakturę za korzystanie z usług API. The developer pays for the use of API products based on the payment terms set by the plan(s) included on the invoice. Dostawca interfejsu API przypisuje deweloperom status płatności po wykonaniu usługi lub przedpłaty. |
| Punkty cenowe | Zakres możliwych cen, po których można sprzedawać produkt. |
| Plan taryfowy z arkusza stawek | Plan taryfowy, w którym deweloper płaci stałą lub zmienną stawkę za każdą transakcję obejmującą spieniężoną usługę API. |
| Plan taryfowy | Specyfikacja opłat, innych kosztów i udziału w przychodach za korzystanie z usług API produktów oferowanych w spieniężonym pakiecie interfejsu API. |
| zasób ścieżka |
Koncepcja RESTowa, ścieżka zasobu to jednolity identyfikator zasobów (URI), który identyfikuje ścieżkę sieciową do danego zasobu. |
| Plan taryfowy z udziałem w przychodach | Plan taryfowy, w którym procent przychodów generowanych przez każdą transakcję obejmującą spieniężoną usługę API jest dzielony z deweloperem aplikacji wysyłającej żądanie. |
| Plan taryfowy z udziałem w przychodach i arkuszem stawek | Plan taryfowy, w którym procent przychodów generowanych przez każdą transakcję obejmującą spieniężoną usługę API jest dzielony z deweloperem aplikacji wysyłającej żądanie. Deweloper płaci też stałą lub zmienną opłatę za każdą transakcję. |
| Faktura samofakturowania | Dokument finansowy, który jest generowany zamiast zestawienia udziału w przychodach. Zawiera on szczegółowe informacje o kwocie należnej deweloperowi i działa jako faktura dla dostawcy interfejsu API w imieniu dewelopera. |
| Standardowy plan taryfowy | Plan taryfowy, który jest dostępny do zakupu przez wszystkich deweloperów. |
| Podatek | Łączna kwota podatku naliczona od wykorzystania i opłat dewelopera. |
| Doładowanie | Działanie dewelopera korzystającego z przedpłaty, które polega na dodaniu środków do salda z przedpłaty. |
| Zasady rejestrowania transakcji | Mechanizm, który umożliwia funkcji zarabiania rejestrowanie parametrów transakcji i atrybutów niestandardowych. Funkcja zarabiania potrzebuje tych informacji do przetwarzania zarabiania, np. do stosowania planów taryfowych do żądań i odpowiedzi interfejsu API na podstawie atrybutów niestandardowych zarejestrowanych w każdej transakcji. |
| Agent nieujawniony | Organizacja (lub operator), która uczestniczy w podstawowej dostawie aplikacji, tak że jest uznawana za kupującą treści w imieniu dewelopera (tylko na potrzeby podatkowe tylko). Jako agent nieujawniony organizacja (lub operator) może pobierać i rozliczać podatki należne od użytkowników końcowych. Ten status jest istotny tylko na potrzeby podatkowe – nie ma wpływu na status prawny dewelopera w łańcuchu dostaw. |
| Nieujawniony model podatkowy | Model podatkowy, w którym dostawca interfejsu API odlicza podatek pobrany od użytkowników końcowych i płaci go lokalnym organom podatkowym. |
| Wersja | Wersja interfejsu API dla deweloperó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 połączonych w proxy interfejsu API. Krótko mówiąc, interfejsy API mają wersje, a proxy interfejsu API mają wersje. |