Jak usługa API Management obsługuje zarabianie

DOTYCZY: Wszystkie warstwy usługi API Management

Platforma usługi Azure API Management umożliwia:

• Publikuj interfejsy API, do których subskrybują użytkownicy.
• De-ryzyko implementacji.
• Przyspieszanie skalowania czasu projektu.
• Skalowanie interfejsów API z ufnością.

W tym dokumencie koncentrujemy się na funkcjach usługi API Management, które umożliwiają implementację strategii zarabiania, takie jak zapewnienie bezproblemowego środowiska:

• Odnajdywanie publicznych interfejsów API.
• Wprowadź szczegóły płatności.
• Aktywuj subskrypcję.
• Korzystanie z interfejsu API.
• Monitorowanie użycia.
• Automatycznie płacisz za użycie interfejsu API.

Na poniższym diagramie przedstawiono następujące kluczowe funkcje usługi API Management:

Odnajdywanie interfejsu API

Uruchom interfejs API i dołącz użytkowników interfejsu API przy użyciu wbudowanego portalu dla deweloperów usługi API Management. Podkreślenie dobrej jakości zawartości programistycznej dla portalu dla deweloperów, dzięki czemu użytkownicy interfejsu API mogą bezproblemowo eksplorować interfejsy API i korzystać z nich. Przetestuj zawartość i informacje udostępniane pod kątem ułatwień dostępu, dokładności i użyteczności.

Aby uzyskać szczegółowe informacje na temat dodawania zawartości i kontrolowania znakowania portalu dla deweloperów, zobacz omówienie portalu dla deweloperów.

Pakowanie interfejsu API

Usługa API Management zarządza sposobem tworzenia pakietów interfejsów API i prezentowania ich przy użyciu koncepcji produktów i zasad.

Produkty

Interfejsy API są publikowane za pośrednictwem produktów. Produkty umożliwiają definiowanie:

• Do których interfejsów API może uzyskiwać dostęp subskrybent.
• Określone zasady ograniczania przepustowości, takie jak ograniczenie określonej subskrypcji do limitu przydziału wywołań miesięcznie.

Gdy użytkownik interfejsu API subskrybuje produkt, otrzymuje klucz interfejsu API, który wykonuje wywołania. Początkowo subskrypcja jest ustawiona submitted na stan. Aktywuj subskrypcję, aby umożliwić subskrybentom korzystanie z interfejsów API.

Skonfiguruj produkty usługi API Management w celu spakowania bazowego interfejsu API w celu zdublowania modelu przychodów przy użyciu następujących elementów:

• Relacja jeden do jednego między poszczególnymi warstwami w modelu przychodów.
• Odpowiedni produkt usługi API Management.

Przykładowe projekty używają produktów USŁUGI API Management jako najwyższego poziomu w celu skodyfikowania strategii zarabiania. Produkty usługi API Management odzwierciedlają warstwy modelu przychodów i indeksują konkretny model cen dla każdej warstwy. Ta konfiguracja zapewnia elastyczne, oparte na konfiguracji podejście do przygotowywania strategii zarabiania.

Zasady

Stosowanie zasad usługi API Management w celu kontrolowania jakości usług dla każdego produktu. Przykładowe projekty używają dwóch konkretnych funkcji zasad do kontrolowania jakości usług zgodnie z modelem przychodów:

Funkcja zasad	opis
Norma	Definiuje łączną liczbę wywołań, które użytkownik może wykonać do interfejsu API w określonym przedziale czasu. Na przykład "100 wywołań miesięcznie". Gdy użytkownik osiągnie limit przydziału, wywołania interfejsu API zakończy się niepowodzeniem 403 Forbidden , a obiekt wywołujący otrzyma kod stanu odpowiedzi.
Limit szybkości	Definiuje liczbę wywołań w przesuwanym przedziale czasu, które można wykonać w interfejsie API. Na przykład "200 wywołań na minutę". Zaprojektowano tak, aby zapobiec wzrostowi użycia interfejsu API poza płatną jakością usług przy użyciu wybranego produktu. Po przekroczeniu szybkości wywołania obiekt wywołujący otrzymuje 429 Too Many Requests kod stanu odpowiedzi.

Aby uzyskać więcej informacji na temat zasad, zobacz dokumentację zasad w usłudze Azure API Management .

Użycie interfejsu API

Udzielanie dostępu użytkownikom interfejsu API do interfejsów API za pośrednictwem produktów przy użyciu subskrypcji interfejsu API.

1. Użytkownicy interfejsu API ustanawiają subskrypcje interfejsu API podczas tworzenia konta określonego produktu API Management.
2. Zintegruj proces subskrypcji z dostawcą płatności przy użyciu delegowania usługi API Management.
3. Po pomyślnym podaniu szczegółów płatności użytkownicy uzyskują dostęp do interfejsu API przy użyciu wygenerowanego, unikatowego klucza zabezpieczeń dla subskrypcji.

Aby uzyskać więcej informacji na temat subskrypcji, zobacz dokumentację Subskrypcje w usłudze Azure API Management .

Monitorowanie użycia interfejsu API

Uzyskaj szczegółowe informacje na temat użycia i wydajności interfejsu API przy użyciu wbudowanej analizy usługi API Management. Te analizy udostępniają raporty według:

• interfejs API
• Obszar geograficzny
• Operacje interfejsu API
• Rezultat
• Żądanie
• Subskrypcja
• Czas
• User

Regularnie przeglądaj raporty analityczne, aby dowiedzieć się, jak strategia zarabiania jest wdrażana przez użytkowników interfejsu API.

Aby uzyskać więcej informacji, zobacz Pobieranie analizy interfejsu API w usłudze Azure API Management.

Zabezpieczenia

Kontrolowanie poziomu dostępu dla każdego użytkownika do każdego produktu przy użyciu produktów, zasad interfejsu API i subskrypcji usługi API Management. Zapobiegaj nadużyciom i nadużyciom, udzielając dostępu do interfejsu API na poziomie subskrypcji, jeśli użytkownik pomyślnie uwierzytelnił się u dostawcy płatności, nawet jeśli określony produkt interfejsu API jest bezpłatny.

Integracja

Utwórz bezproblemowe środowisko zarabiania za pośrednictwem integracji frontonu i zaplecza między usługą API Management i wybranym dostawcą płatności. Użyj delegowania usługi API Management na potrzeby integracji frontonu i interfejsu API REST na potrzeby integracji zaplecza.

Delegowanie

W przykładowych projektach można używać delegowania usługi API Management do tworzenia niestandardowych integracji z dostawcami płatności innych firm. W pokazie używane jest delegowanie zarówno w środowiskach rejestracji,logowania, jak i subskrypcji produktu.

Przepływ pracy tworzenia konta/logowania

1. Deweloper kliknie link logowania lub rejestracji w portalu deweloperów usługi API Management.
2. Przeglądarka przekierowuje do punktu końcowego delegowania (skonfigurowanego do strony w niestandardowej aplikacji portalu rozliczeniowego).
3. Niestandardowa aplikacja portalu rozliczeniowego przedstawia interfejs użytkownika logowania/rejestracji.
4. Po pomyślnym zalogowaniu się/rejestracji użytkownik jest uwierzytelniany i przekierowywany z powrotem do początkowej strony portalu deweloperów usługi API Management.

Przepływ pracy subskrypcji produktu

1. Deweloper wybiera produkt w portalu deweloperów usługi API Management i klika przycisk Subskrybuj
2. Przeglądarka przekierowuje do punktu końcowego delegowania (skonfigurowanego do strony w niestandardowej aplikacji portalu rozliczeniowego).
3. Niestandardowa aplikacja portalu rozliczeniowego:
   • Przedstawia interfejs użytkownika skonfigurowany na podstawie dostawcy płatności (Stripe lub Adyen).
   • Przejmie użytkownika przez odpowiedni proces wyewidencjonowania.
4. Użytkownik jest przekierowywany z powrotem do początkowej strony produktu API Management.
   • Produkt będzie aktywny, a klucze interfejsu API będą dostępne.

Interfejs API REST

Użyj interfejsu API REST dla usługi API Management, aby zautomatyzować działanie strategii zarabiania.

Przykładowe projekty używają interfejsu API do programowego:

• Pobierz produkty i zasady usługi API Management, aby włączyć zsynchronizowaną konfigurację podobnych pojęć u dostawców płatności, takich jak Stripe.
• Usługa API Management sondowania regularnie pobiera metryki użycia interfejsu API dla każdej subskrypcji i napędza proces rozliczeniowy.

Aby uzyskać więcej informacji, zobacz Omówienie usługi Azure API Management interfejsu API REST.

DevOps

Kontrola wersji i automatyzowanie zmian wdrażania w usłudze API Management przy użyciu usługi Azure Resource Manager, w tym konfigurowanie funkcji implementujących strategię zarabiania, na przykład:

• Produkty
• Zasady
• Portal dla deweloperów

W przykładowych projektach skrypty usługi Azure Resource Manager są rozszerzane przez plik JSON, który definiuje model cen każdego produktu API Management. Dzięki temu rozszerzeniu można zsynchronizować konfigurację między usługą API Management i wybranym dostawcą płatności. Całe rozwiązanie jest zarządzane w ramach jednego repozytorium kontroli źródła, aby:

• Koordynuj wszystkie zmiany związane z bieżącą ewolucją strategii monetyzacji jako pojedynczą wersją.
• Przeprowadź zmiany zgodnie z wymaganiami dotyczącymi ładu i inspekcji.

Inicjowanie i wdrażanie

Usługę API Management można wdrożyć za pomocą następujących elementów:

• Interfejs użytkownika witryny Azure Portal lub
• Podejście "infrastruktura jako kod" przy użyciu szablonów usługi Azure Resource Manager.

Filmy wideo

Integrowanie usługi API Management z bramą płatności adyen

Integrowanie usługi API Management z bramą płatności Stripe

Następne kroki

• Dowiedz się więcej o strategiach monetyzacji usługi API Management.
• Wdróż demonstracyjną integrację z usługą Adyen lub Stripe za pośrednictwem skojarzonego repozytorium Git.