Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje
Portale dla deweloperów z funkcjami publikowania społecznościowego są coraz częściej używane do komunikacji ze społecznością deweloperów. Obejmuje to przesyłanie treści statycznych, np. dokumentacji interfejsów API i warunków korzystania z usługi, a także dynamicznych treści publikowanych przez społeczność, np. blogów i forów.
Jako dostawca interfejsów API potrzebujesz sposobu na udostępnianie swoich interfejsów API, informowanie deweloperów o tych interfejsach oraz rejestrowanie deweloperów i zezwalanie na rejestrowanie aplikacji. Udostępnienie interfejsów API programistom to tylko część tworzenia naprawdę dynamicznej społeczności. Musisz też mieć możliwość przekazywania opinii, przesyłania próśb o dodanie funkcji do zespołu pomocy, przesyłania próśb o dodanie funkcji oraz przesyłania własnych treści, do których dostęp mają inni deweloperzy.
Apigee Edge udostępnia portal usług dla programistów, w którym możesz utworzyć i uruchomić własną, dostosowaną witrynę, w której będziesz udostępniać wszystkie te usługi swojej społeczności programistów. Każdy klient Edge może utworzyć własny portal dla programistów (w chmurze lub lokalnie).
W tym filmie przedstawiamy portal Apigee Developer Services.
Poniższy rysunek przedstawia stronę główną domyślnego portalu dla programistów:
Portal dla programistów to system zarządzania treścią (CMS) oparty na projekcie open source Drupal (http://www.drupal.org). Podstawowy zestaw funkcji w Drupal jest dostępny w postaci modułów, które ułatwiają tworzenie treści na potrzeby witryn i zarządzanie nimi.
Portal dla programistów od razu pozwala utworzyć dokumentację interfejsów API, obsługuje blogowanie i udostępnia fora z wątkami. Możesz też dostosować portal dla deweloperów do swoich wymagań. Dostosowywanie pozwala zmienić wygląd portalu oraz sposób, w jaki programiści będą z niego korzystać.
Większość ustawień wykonujesz w menu Drupal. Jeśli zalogujesz się w portalu jako użytkownik z uprawnieniami administratora, u góry każdej strony portalu pojawi się menu Drupal:
Administracja kontroluje proces, w którym deweloperzy proszą o dostęp do portalu, jak rejestrują aplikacje uzyskujące dostęp do Twoich interfejsów API, jak przypisujesz im określone role i uprawnienia związane z interfejsami API oraz kiedy mogę anulować dostęp programisty do interfejsów API.
Portal dla deweloperów służy też do konfigurowania i kontrolowania zarabiania. Generowanie przychodu umożliwia deweloperom samoobsługowy dostęp w portalu dla deweloperów do ustawień płatności i raportów, katalogu i abonamentów oraz ustawień zarabiania.
Typy użytkowników portalu
Na tej ilustracji widać 2 typy użytkowników portalu:
- Deweloperzy to społeczność użytkowników, którzy tworzą aplikacje przy użyciu interfejsów API. Programiści aplikacji używają portalu do poznawania interfejsów API za pomocą aplikacji SmartDokumentacja, rejestracji konta w portalu, rejestrowania aplikacji korzystających z interfejsów API, komunikowania się ze społecznością programistów oraz wyświetlania w panelu informacji statystycznych o korzystaniu z aplikacji.
-
Zespół interfejsów API to dostawca interfejsów API, który tworzy treści portalu, udostępnia ich interfejsy API deweloperom aplikacji, dostarcza dokumentację interfejsów API oraz umożliwia deweloperom rejestrowanie aplikacji i uzyskiwanie kluczy interfejsu API. Zespół ds. interfejsów API przeprowadza podstawową konfigurację portalu dla programistów, aby:
- Konfigurowanie automatycznych lub ręcznych żądań kluczy interfejsu API
- prowadzić dokumentację, fora i blogi związane z interfejsem API oraz opcjonalnie wprowadzać wszystkie zmiany;
- Obsługa komentarzy użytkowników i moderowania forum
- Wymuszaj kontrolę dostępu opartą na rolach (RBAC), aby kontrolować dostęp do funkcji w portalu. Administrator może na przykład włączyć opcje umożliwiające zarejestrowanym użytkownikom tworzenie postów na forum lub korzystanie z konsol testowych.
- Dostosuj e-maile z powiadomieniami dla administratorów i programistów dotyczące tworzenia i zatwierdzania użytkowników
- Dostosuj formularze internetowe, np. strony z informacjami kontaktowymi
Na tym ilustracji widać trzeci typ użytkownika portalu – menedżer usługi API. Menedżer usługi API odpowiada za określenie sposobu tworzenia portalu przez zespół ds. interfejsów API, w tym za:
- Definiowanie sposobu pakowania interfejsów API do produktów
- Definiowanie reguł zatwierdzania aplikacji
- Jeśli w portalu włączono Zarabianie, musisz określić ceny i abonamenty dotyczące usług API. Więcej informacji o zarabianiu znajdziesz w artykule Generowanie przychodu ogółem.
Dostosowywanie portalu dla programistów
Jako dostawca interfejsów API zastanów się, jak dostosować portal dla programistów do swoich interfejsów API i udostępnić społeczności programistów informacje niezbędne do korzystania z interfejsów API. Oto kilka kwestii dotyczących portalu niestandardowego:
- Łatwy dostęp do interfejsów API
- dokumentację, np. instrukcje i dokumenty referencyjne;
- treści przesyłane przez społeczność, np. blogi i fora dyskusyjne
- Przykładowy kod
- Łatwy proces rejestracji, który umożliwia szybkie zatwierdzenie nowych deweloperów, aplikacji i interfejsów API.
- Zarządzane uprawnienia i dane logowania
- Wielopoziomowa kontrola dostępu
- Wygląd i styl zgodny z Twoją organizacją
Portal jest wstępnie gotowy z podstawową konfiguracją. Na przykład od razu skonfigurowano portal umożliwiający rejestrację wszystkim użytkownikom, ale administrator musi zatwierdzić każdą rejestrację, zanim deweloper będzie mógł się do niego zalogować. Po zatwierdzeniu rejestracji deweloper może zarejestrować aplikację, aby zażądać klucza interfejsu API i użyć portalu do uzyskania dostępu do zasobów interfejsu API.
Etapy procesu domyślnej rejestracji to:
- Deweloper rejestruje się przez portal dla deweloperów. W odpowiedzi portal wysyła do administratorów e-maila z prośbą o zatwierdzenie konta.
- Administrator zatwierdza konto, a deweloper otrzymuje e-maila z informacją, że może już się zalogować.
- Programista rejestruje aplikację i wybiera do niej usługi API. W odpowiedzi portal przypisuje do aplikacji unikalny klucz interfejsu API.
- Deweloper przekazuje klucz interfejsu API podczas wysyłania żądań do Twojego interfejsu API.
Jest to gotowe rozwiązanie, które można dostosować do własnych potrzeb. Możesz na przykład zastąpić domyślny schemat rejestracji i autoryzacji, aby nowy deweloper był automatycznie zatwierdzony i zalogowany po rejestracji. Możesz też wymagać od dewelopera zaakceptowania zestawu warunków, zanim będzie mógł się zalogować po raz pierwszy.
Masz też pełną kontrolę nad treściami dostępnymi w portalu dla programistów. Portal dla deweloperów od razu zawiera przykładowe treści, takie jak dokumentacja interfejsu API, posty na blogu i dyskusje na forum. Możesz dodać własne treści i dostosować wygląd poszczególnych typów treści.
Więcej informacji znajdziesz w artykule Dostosowywanie wyglądu.
Administrowanie portalem dla programistów
Aby uzyskać dostęp do Twojego interfejsu API i z niego korzystać, deweloperzy mogą korzystać z portalu dla deweloperów. Administratorzy mogą wykonywać takie zadania związane z zarządzaniem kontem, jak:
- Dostosowywanie procesu rejestracji dewelopera, w tym pola rejestracji, wbudowane badanie CAPTCHA oraz automatyczne lub ręczne zatwierdzanie
- dodawania lub zatwierdzania deweloperów; Domyślnie każdy programista może zarejestrować się przez portal dla programistów, ale musi zostać zatwierdzony przez administratora w interfejsie Portalu dla programistów. Administratorzy mogą też tworzyć programistów bezpośrednio w portalu. Portal automatycznie otrzyma wtedy e-maila z informacją o utworzeniu dla niego konta.
- Modyfikowanie konta dewelopera. Administratorzy mogą na przykład zmienić stan konta użytkownika z aktywnego na zablokowane lub zmienić informacje o profilu dewelopera, takie jak nazwa firmy.
- usunąć dewelopera. Administratorzy mogą wyłączyć lub usunąć konto dewelopera.
- Przypisywanie ról i uprawnień: administratorzy mogą przypisywać konkretną rolę do konta dewelopera. Rola jest powiązana z różnymi uprawnieniami, takimi jak uprawnienie do tworzenia książek lub innych treści. Możesz też zmienić uprawnienia powiązane z rolą lub utworzyć nowe role.
Więcej informacji znajdziesz w artykule Dodawanie kont użytkowników i zarządzanie nimi.
Podsumowanie funkcji portalu dla programistów
Poniższa tabela zawiera podsumowanie funkcji portalu dla programistów:
| Funkcja | Szczegóły |
|---|---|
| Obsługiwane przeglądarki | |
|
Rejestracja użytkownika |
|
|
Zarządzanie użytkownikami |
|
|
Wygląd portalu |
|
|
Zarządzanie treściami i społecznością |
|
|
Uprawnienia |
|
|
Zarządzanie kluczami interfejsu API |
|
|
Wyślij e-mailem |
|
|
Blogi |
|
|
Fora |
|
|
Dokumentacja |
|
|
Menu |
|
|
Wyszukiwarka |
|
|
Sprawdzenie linków |
|