Tworzenie zintegrowanego portalu

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Apigee Edge to prosty w obsłudze, zintegrowany portal umożliwiający dokumentowanie dostępu do interfejsów API i zarządzanie nim, a także budowanie społeczności programistów aplikacji.

Wszyscy użytkownicy Apigee Edge mają dostęp do zintegrowanych narzędzi programistycznych związanych z portalem, dzięki czemu mogą szybko utworzyć własny portal dla programistów, co stanowi alternatywę dla programowania portalu opartego na Drupal. Porównanie funkcji znajdziesz w artykule Porównanie funkcji portalu dla programistów.

Obejrzyj ten krótki film wprowadzający do tworzenia i publikowania zintegrowanego portalu.

Najważniejsze funkcje i korzyści

Zintegrowany portal oferuje następujące najważniejsze funkcje i zalety:
Funkcja Zalety
Tworzenie treści portalu Szybko i łatwo zaprogramuj zawartość portalu.
  • Tworzenie stron za pomocą prostego edytora stron
  • Używanie formatu Markdown i HTML do tworzenia treści
  • Dodaj menu na potrzeby poruszania się po portalu
Wygląd i styl portalu W pełni dostosuj wygląd i sposób działania portalu za pomocą arkuszy stylów SCSS i spersonalizowanych elementów marki.
Dokumentacja interfejsu API Automatycznie generuj dokumentację API na podstawie specyfikacji OpenAPI.
Rejestracja samoobsługowa Zapewnij deweloperom możliwość samodzielnej rejestracji, aby mogli tworzyć aplikacje przy użyciu interfejsów API.
Zarządzanie odbiorcami Kontroluj, kto może uzyskać dostęp do zawartości portalu i interfejsów API
Analityka Skonfiguruj Google Analytics i śledzenie niestandardowe.
Zaawansowane opcje dostosowywania Przeprowadzaj zaawansowane dostosowania portalu, takie jak:
  • Dostosuj domenę
  • Dodaj niestandardowe pola rejestracji
  • Rozszerz swój portal za pomocą skryptów
  • Skonfiguruj pocztę e-mail

Rozpocznij tworzenie portalu

Jak Apigee rozwiązuje problemy z zabezpieczeniami w zintegrowanym portalu

W tabeli poniżej opisano, jak Apigee dba o bezpieczeństwo przy użyciu funkcji wbudowanych w zintegrowanym portalu.

Funkcja Adresy
Wymaga protokołu HTTPS i TLS (Transport Layer Security) Wymusza szyfrowanie komunikacji
Obejmuje rejestrację domeny apigee.io na liście domen publicznych Nie zezwala na ustawianie „superplików cookie” w subdomenach apigee.io
Obsługuje konfigurację polityki bezpieczeństwa treści (CSP) Chroni przed atakami typu cross-site scripting (XSS) i innymi atakami polegającymi na wstrzyknięciu kodu
Wymagane:
  • Sanityzacja danych wejściowych formularza
  • Wstrzykiwanie kodu JavaScript w całej witrynie dostępne tylko dla administratorów
Chroni przed atakami HTML, SQL i wstrzyknięciem backendu.
Zawiera x-content-type-options: nosniff nagłówek XSS Nie pozwala przeglądarkom na odgadnięcie typów MIME
Zawiera x-frame-options: deny nagłówek XSS Nie zezwala na umieszczanie treści portalu w elemencie iframe
Zawiera x-xss-protection: 1 nagłówek XSS Nie pozwala na ładowanie stron, jeśli wykryją ataki typu cross-site scripting (XSS)
Używa tokenów CSRF Chroni przed fałszowaniem żądań pochodzących z innych witryn
Wykorzystuje: Ochrona danych klientów

Jak zintegrowany portal komunikuje się z Edge

Większość informacji używanych przez portal dla programistów jest przechowywana w Apigee Edge. Portal jest klientem Edge. W razie potrzeby portal dla programistów wysyła żądanie HTTP lub HTTPS REST, aby pobrać informacje z Edge lub wysłać je do tej usługi. Jeśli na przykład użytkownik portalu zarejestruje w nim nową aplikację, portal wyśle do Edge żądanie zapisania informacji o tej aplikacji.

Więcej informacji znajdziesz w sekcjach poniżej.

Przechowywanie rejestracji aplikacji i kluczy interfejsu API

Gdy użytkownik portalu zakończy proces rejestracji aplikacji w zintegrowanym portalu, portal wyśle do Apigee Edge informacje o aplikacji, w tym jej nazwę i powiązane z nią usługi API. Jeśli Edge zarejestruje aplikację, Edge zwraca do portalu pojedynczy klucz interfejsu API. Użytkownik portalu używa tego klucza interfejsu API, aby uzyskać dostęp do usług API powiązanych z aplikacją.

Informacje o aplikacjach i kluczach interfejsu API są przechowywane tylko na Edge i nie są przechowywane w portalu. Gdy użytkownik portalu korzysta z portalu do wyświetlania informacji o aplikacji, na przykład na stronie Moje aplikacje, portal wysyła do Edge z kluczem interfejsu API żądanie dostępu do tych informacji.

Podobnie, gdy użytkownik portalu doda, usunie lub zmieni aplikację, portal wyśle do Edge w celu zapisania modyfikacji.

Wszystkie informacje o aplikacjach i kluczach interfejsu API są przechowywane w Edge, dlatego administrator Edge może modyfikować te informacje przy użyciu interfejsu użytkownika Edge lub interfejsu API zarządzania. Administrator może na przykład:

  • Dodawanie, usuwanie i modyfikowanie aplikacji dewelopera
  • Zatwierdzanie i unieważnianie klucza interfejsu API dla aplikacji dewelopera

Więcej informacji znajdziesz w artykule Rejestrowanie aplikacji i zarządzanie kluczami interfejsu API.

Gdzie przechowywane są informacje o koncie dewelopera aplikacji

Informacje o koncie dewelopera są przechowywane w Edge w ten sposób:

W Edge są przechowywane te informacje o koncie użytkownika:

  • Imię i nazwisko
  • adres e-mail,
  • Nazwa użytkownika
  • Stan konta w portalu (aktywne lub nieaktywne)
  • Rola w portalu (uwierzytelniony użytkownik, administrator, inny)
  • Uprawnienia oparte na rolach
  • Zespoły, do których należy użytkownik portalu (jeśli zarejestrujesz się w wersji beta funkcji zespołów)

Adres e-mail to podstawowy klucz używany przez Edge do identyfikacji dewelopera. Każdy z nich musi być unikalny. Na podstawie klucza podstawowego Edge generuje unikalny identyfikator dewelopera dla każdej organizacji, do której należy.

Więcej informacji znajdziesz w artykule Rejestrowanie deweloperów aplikacji.

Miejsce przechowywania informacji o zespole deweloperów (wersja beta)

Gdy użytkownik portalu utworzy w portalu zespół programistów, w Edge są przechowywane informacje o tym zespole, w tym:

  • Nazwa i opis zespołu dewelopera
  • Członkowie zespołu deweloperów i ich role
  • Aplikacje, do których przypisany jest zespół programistów
  • Listy odbiorców przypisane do zespołu programistów
  • Czas utworzenia zespołu programistów

Dla zespołu programistów generowany jest unikalny, generowany automatycznie adres e-mail, który jest podstawowym kluczem używanym przez Edge do identyfikowania zespołu programistów.

Więcej informacji znajdziesz w artykułach Współdzielenie odpowiedzialności za aplikację przy użyciu zespołów programistów (beta) i Zarządzanie zespołami deweloperów.

Informacje o przykładowym portalu

Podczas tworzenia nowego portalu dostępny jest zestaw stron początkowych, których możesz używać jako punktu wyjścia. Na stronach startowych znajdują się materiały demonstracyjne, które mogą zainspirować Cię przy tworzeniu własnego portalu, gdy będziesz zastępować tekst i obrazy własnymi treściami. Przykładowy motyw portalu korzysta z szablonów interfejsu Material Design i SCSS.

Poniżej widać stronę główną przykładowego portalu.

Strony startowe w przykładowym portalu:

Strona Opis
Dom Strona główna portalu opisująca pokazane interfejsy API. Pełni funkcję domyślnej strony głównej portalu (index.html). Demonstracja użycia komponentów kanciastych zgodnie z opisem w sekcji Dodawanie komponentów materiału kanciastego.
Szybki start Zestaw krótkich instrukcji pokazujących, jak dostosować portal. Kliknij Szybki start w przykładowym portalu, aby dodać treści na stronie Pierwsze kroki.
Rozpocznij Strona z przykładową treścią. Aby dowiedzieć się, jak edytować tę stronę i dodać ją do górnego menu nawigacyjnego, zapoznaj się ze stroną Pierwsze kroki w przykładowym portalu.
Interfejsy API Lista dostępnych interfejsów API. Gdy generujesz interaktywną dokumentację API, linki do treści są automatycznie dodawane do tej strony.

Uwaga: zawartość tej strony jest generowana automatycznie na podstawie interfejsów API, które publikujesz w swoim portalu. Nie możesz bezpośrednio edytować zawartości tej strony. Nie pojawia się ona na liście stron. Styl strony możesz zmienić w edytorze motywów portalu.
Moje aplikacje Lista aplikacji zarejestrowanych dla autoryzowanego użytkownika. Zobacz Jak użytkownicy portalu korzystają z portalu.

Uwaga: zawartość tej strony jest generowana automatycznie na podstawie zarejestrowanych aplikacji użytkowników. Nie możesz bezpośrednio edytować zawartości strony. Nie pojawia się ona na liście stron. Styl strony możesz zmienić za pomocą edytora motywów.
Zaloguj się Strona logowania dla zarejestrowanych użytkowników. Nowi użytkownicy mogą się zarejestrować na tej stronie, klikając Zaloguj się. Zobacz artykuł Jak użytkownicy portalu korzystają z portalu.

Uwaga: strona logowania jest automatycznie dodawana do portalu. Na stronie logowania możesz dostosować logo, a na stronie Tworzenie konta dodać niestandardowe pola rejestracji. Nie możesz bezpośrednio edytować zawartości strony. Nie pojawia się ona na liście stron.
Warunki korzystania z usługi Przykładowa strona z warunkami korzystania z usługi

Obsługiwane przeglądarki

Zintegrowane portale Apigee obsługują te same wersje przeglądarek co Apigee Edge.