Tworzenie zintegrowanego portalu

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

Apigee Edge udostępnia prosty w użyciu zintegrowany portal do dokumentowania interfejsów API i zarządzania dostępem do nich oraz do wspierania społeczności deweloperów aplikacji.

Wszyscy użytkownicy Apigee Edge mają dostęp do narzędzi do tworzenia zintegrowanego portalu, które umożliwiają im szybkie tworzenie własnego portalu dla programistów, co stanowi alternatywę dla tworzenia portalu opartego na Drupalu. Porównanie funkcji znajdziesz w artykule Porównanie funkcji portalu dla programistów.

Najważniejsze funkcje i korzyści

Zintegrowany portal oferuje te najważniejsze funkcje i korzyści:

Funkcja	Korzyści
Tworzenie treści portalu	Szybkie i łatwe tworzenie treści portalu. Tworzenie stron za pomocą prostego w użyciu edytora stron Tworzenie treści za pomocą języków Markdown i HTML Dodawanie menu do nawigacji po portalu
Wygląd portalu	Pełne dostosowanie wyglądu portalu za pomocą arkuszy stylów SCSS i spersonalizowanych elementów marki.
Dokumentacja API	Automatyczne generowanie dokumentacji API na podstawie specyfikacji OpenAPI.
Rejestracja samoobsługowa	Umożliwienie programistom samodzielnej rejestracji, aby mogli tworzyć aplikacje za pomocą Twoich interfejsów API.
Zarządzanie odbiorcami	Kontrolowanie, kto może uzyskiwać dostęp do treści portalu i interfejsów API.
Analytics	Konfigurowanie Google Analytics i niestandardowego śledzenia statystyk.
Zaawansowane opcje dostosowywania	Wykonywanie zaawansowanych dostosowań portalu, w tym: Dostosowywanie domeny Dodawanie niestandardowych pól rejestracji Rozszerzanie portalu za pomocą skryptów Konfigurowanie poczty e-mail

Rozpoczynanie tworzenia portalu

Jak Apigee dba o bezpieczeństwo w zintegrowanym portalu

W tabeli poniżej opisano, jak Apigee dba o bezpieczeństwo za pomocą wbudowanych funkcji zintegrowanego portalu.

Funkcja	Adresy
Wymaga protokołu HTTPS i zabezpieczenia warstwy transportu (TLS)	Wymusza szyfrowanie komunikacji
Obejmuje rejestrację domeny apigee.io z listą sufiksów publicznych	Uniemożliwia ustawianie „supercookies” w subdomenach apigee.io
Obsługuje konfigurację Content Security Policy (CSP)	Chroni przed atakami typu cross-site scripting (XSS) i innymi atakami polegającymi na wstrzykiwaniu kodu
Wymaga: czyszczenia danych wejściowych formularza, ograniczenia wstrzykiwania JavaScriptu w całej witrynie do administratorów.	Chroni przed atakami polegającymi na wstrzykiwaniu kodu HTML, SQL lub kodu backendu
Zawiera nagłówek XSS x-content-type-options: nosniff	Uniemożliwia przeglądarkom próbę odgadnięcia typów MIME
Zawiera nagłówek XSS x-frame-options: deny	Uniemożliwia osadzanie treści portalu w elemencie iframe
Zawiera nagłówek XSS x-xss-protection: 1	Uniemożliwia wczytywanie stron, gdy wykryją one ataki typu reflected cross-site scripting (XSS)
Używa tokenów CSRF	Chroni przed atakami typu żądanie z innej witryny forgery
Wykorzystuje: szyfrowanie danych w spoczynku w Google Cloud, zasady Google dotyczące danych użytkowników i ich przechowywania, izolację najemców, przechowywanie danych logów i danych debugowania (6 tygodni).	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 działa jako klient Edge. W razie potrzeby portal dla programistów wysyła żądanie HTTP lub HTTPS REST, aby pobrać informacje z Edge lub wysłać do niego informacje. Gdy na przykład użytkownik portalu zarejestruje w nim nową aplikację, portal wyśle do Edge żądanie zapisania informacji o aplikacji.

Więcej informacji znajdziesz w sekcjach poniżej.

Miejsce przechowywania rejestracji aplikacji i kluczy interfejsu API

Gdy użytkownik portalu zakończy proces rejestracji aplikacji w zintegrowanym portalu, portal wyśle informacje o aplikacji do Apigee Edge, w tym nazwę aplikacji i usługi API powiązane z aplikacją. Jeśli Edge zarejestruje aplikację, zwróci 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 w Edge, a nie w portalu. Gdy użytkownik portalu używa portalu do wyświetlania informacji o aplikacji, np. na stronie Moje aplikacje, portal wysyła do Edge żądanie z kluczem interfejsu API, aby uzyskać dostęp do informacji.

Podobnie, gdy użytkownik portalu dodaje, usuwa lub modyfikuje aplikację, portal wysyła zmiany do Edge, aby je zapisać.

Ponieważ wszystkie informacje o aplikacjach i kluczach interfejsu API są przechowywane w Edge, administrator Edge może je modyfikować za pomocą interfejsu Edge lub interfejsu API zarządzania. Administrator może na przykład:

• dodawać, usuwać lub modyfikować aplikację dewelopera;
• zatwierdzać lub unieważniać klucz interfejsu API aplikacji dewelopera.

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

Miejsce przechowywania informacji o koncie dewelopera aplikacji

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

• Gdy użytkownik portalu utworzy konto za pomocą wbudowanego dostawcy tożsamości, informacje zostaną zapisane u dostawcy tożsamości i wyświetlone na stronie Użytkownicy.
• Gdy użytkownik portalu zaloguje się w portalu za pomocą dostawcy tożsamości SAML, u dostawcy tożsamości zostanie zapisany cień informacji, który zostanie wyświetlony na stronie Użytkownicy.
• Gdy użytkownik portalu zarejestruje aplikację dewelopera, informacje o koncie użytkownika zostaną zsynchronizowane z Edge i będą dostępne na stronie Deweloperzy.

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, inna)
• Uprawnienia na podstawie roli
• Zespoły, do których należy użytkownik portalu (jeśli masz dostęp do wersji beta funkcji zespołów)

Adres e-mail jest kluczem podstawowym używanym przez Edge do identyfikowania dewelopera i musi być unikalny. Na podstawie klucza podstawowego Edge generuje unikalny identyfikator dewelopera dla każdej organizacji, do której należy deweloper.

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 nim zespół deweloperów, informacje o zespole deweloperów zostaną zapisane w Edge, w tym:

• nazwa i opis zespołu deweloperów;
• członkowie zespołu deweloperów i ich role;
• aplikacje, do których jest przypisany zespół deweloperów;
• odbiorcy przypisani do zespołu deweloperów;
• czas utworzenia zespołu deweloperów.

Dla zespołu deweloperów jest generowany unikalny, automatycznie wygenerowany adres e-mail, który służy jako klucz podstawowy używany przez Edge do identyfikowania zespołu deweloperów.

Więcej informacji znajdziesz w artykułach Dzielenie odpowiedzialności za aplikację za pomocą zespołów deweloperów (wersja beta) i Zarządzanie zespołami deweloperów.

Informacje o przykładowym portalu

Gdy utworzysz nowy portal, otrzymasz zestaw stron startowych, których możesz użyć jako punktu wyjścia. Strony startowe zawierają treści demonstracyjne, które pomogą Ci w tworzeniu własnego portalu. Wystarczy, że zastąpisz tekst i obrazy własnymi treściami. Motyw przykładowego portalu korzysta z motywów Material Design i SCSS.

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

Strony startowe udostępniane z przykładowym portalem:

Strona	Opis
Strona główna	Strona główna portalu, która opisuje prezentowane interfejsy API. Służy jako domyślna strona główna portalu (index.html). Pokazuje, jak używać komponentów Angular Material, zgodnie z opisem w artykule Dodawanie komponentów Angular Material.
Szybki start	Zestaw szybkich kroków, które pokazują, jak dostosować portal. W przykładowym portalu kliknij Szybki start , aby przejść przez proces dodawania treści do strony Rozpocznij.
Rozpocznij	Przykładowa strona z treścią. Na stronie Rozpocznij w przykładowym portalu dowiesz się, jak edytować tę stronę i dodać ją do górnego menu nawigacyjnego.
Interfejsy API	Lista dostępnych interfejsów API. Gdy wygenerujesz interaktywną dokumentację API, linki do treści zostaną automatycznie dodane do tej strony. Uwaga: zawartość tej strony jest generowana automatycznie na podstawie interfejsów API, które publikujesz w portalu. Nie możesz bezpośrednio edytować zawartości tej strony. Nie jest ona widoczna na liście stron. Stylizację strony możesz modyfikować za pomocą edytora motywów portalu.
Moje aplikacje	Lista zarejestrowanych aplikacji uwierzytelnionego użytkownika. Zapoznaj się z artykułem Jak użytkownicy portalu korzystają z Twojego portalu. Uwaga: zawartość tej strony jest generowana automatycznie na podstawie zarejestrowanych aplikacji użytkownika. Nie możesz bezpośrednio edytować zawartości tej strony. Nie jest ona widoczna na liście stron. Stylizację strony możesz modyfikować za pomocą edytora motywów.
Zaloguj się	Strona logowania dla zarejestrowanych użytkowników. Nowi użytkownicy mogą zarejestrować się na tej stronie, klikając Zaloguj się. Zapoznaj się z artykułem Jak użytkownicy portalu korzystają z Twojego portalu. Uwaga: strona logowania jest automatycznie dodawana do portalu. Możesz dostosować logo na stronie logowania i dodać niestandardowe pola rejestracji na stronie Utwórz konto. Nie możesz bezpośrednio edytować zawartości tej strony. Nie jest ona widoczna na liście stron.
Warunki korzystania z usługi	Przykładowa strona z warunkami korzystania z usługi.

Obsługa przeglądarek

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