Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje
Portale dla deweloperów z funkcjami publikowania treści społecznościowych są coraz częściej wykorzystywane do komunikacji z poszczególnymi deweloperami. Dotyczy to treści statycznych, takich jak dokumentacja interfejsu API i warunki korzystania z usługi, a także dynamicznych treści tworzonych przez społeczność, takich jak blogi i fora.
Jako dostawca interfejsu API musisz udostępniać interfejsy API, informować deweloperów o ich istnieniu, rejestrować deweloperów i umożliwiać im rejestrowanie aplikacji. Udostępnianie interfejsów API programistom to tylko część procesu tworzenia naprawdę dynamicznej społeczności. Musisz też zapewnić społeczności deweloperów możliwość przesyłania opinii, zgłaszania próśb o pomoc i prośb o wprowadzenie nowych funkcji oraz przesyłania własnych treści, do których inni deweloperzy będą mieć dostęp.
Apigee Edge udostępnia portal usług dla programistów, za pomocą którego możesz tworzyć i uruchamiać własną witrynę dostosowaną do potrzeb, aby udostępniać te wszystkie 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.
Film poniżej przedstawia portal usług dla deweloperów Apigee.
Na rysunku poniżej widać stronę główną domyślnego portalu dla deweloperów:
Portal deweloperski to system zarządzania treścią (CMS) oparty na projekcie Drupal (http://www.drupal.org) typu open source. Drupal zapewnia podstawowy zestaw funkcji w postaci modułów, które ułatwiają tworzenie treści do witryn oraz zarządzanie nimi.
Bezpośrednio na portalu dla deweloperów możesz tworzyć dokumentację interfejsu API, publikować blogi i uczestniczyć w dyskusjach na forach. Możesz też dostosować portal deweloperski do swoich potrzeb. Dzięki niej możesz modyfikować wygląd portalu oraz sposób, w jaki deweloperzy z nim współpracują.
Większość dostosowań wykonujesz w menu Drupala. Jeśli zalogujesz się w portalu jako użytkownik z uprawnieniami administratora, u góry każdej strony portalu będzie widoczne menu Drupala:
Administracja kontroluje proces, w którym deweloperzy proszą o dostęp do portalu, sposób rejestrowania przez deweloperów aplikacji uzyskujących dostęp do Twoich interfejsów API, sposób przypisywania deweloperom określonych ról i uprawnień związanych z Twoimi interfejsami API oraz moment odmowy dostępu deweloperom do interfejsów API.
Na portalu dewelopera możesz też konfigurować zarabianie i nim zarządzać. Funkcja zarabiania daje deweloperom dostęp do opcji Płatności i raporty, Katalog i plany oraz ustawień dotyczących zarabiania w portalu dewelopera.
Typy użytkowników portalu
Na ilustracji poniżej pokazano 2 typy użytkowników portalu:
- Deweloperzy to społeczność użytkowników, którzy tworzą aplikacje za pomocą Twoich interfejsów API. Deweloperzy aplikacji korzystają z portalu, aby dowiedzieć się więcej o Twoich interfejsach API za pomocą SmartDocs, zarejestrować konto w portalu, zarejestrować aplikacje korzystające z Twoich interfejsów API, wchodzić w interakcje z społecznością deweloperów i wyświetlać w panelu informacje statystyczne o używaniu aplikacji.
-
Zespół interfejsu API to dostawca interfejsu API, który tworzy treści portalu, udostępnia interfejsy API programistom aplikacji, zapewnia dokumentację interfejsu API oraz mechanizm rejestracji aplikacji i uzyskiwania kluczy interfejsu API. Zespół interfejsu API wykonuje podstawową konfigurację portalu dla deweloperów, aby:
- Konfigurowanie automatycznych lub ręcznych próśb o klucze interfejsu API
- Prowadzenie dokumentacji interfejsu API, forów i blogów oraz opcjonalnie wprowadzanie zmian
- Zarządzanie komentarzami użytkowników i moderowanie forum
- Wymuś kontrolę dostępu opartą na rolach (RBAC), aby kontrolować dostęp do funkcji w portalu. Na przykład administrator może włączyć opcje, które pozwolą zarejestrowanemu użytkownikowi tworzyć posty na forum lub korzystać z konsoli testowej.
- dostosowywanie powiadomień e-mail wysyłanych do administratorów i programistów w związku z tworzeniem i zatwierdzaniem użytkowników;
- dostosowywanie formularzy internetowych, np. stron „skontaktuj się z nami”;
Na tym rysunku nie pokazano trzeciego typu użytkownika portalu – menedżera interfejsu API. Menedżer produktu interfejsu API odpowiada za określenie sposobu tworzenia portalu przez zespół interfejsu API, w tym:
- określanie sposobu pakowania interfejsów API w usługi;
- Definiowanie reguł zatwierdzania aplikacji
- Jeśli na portalu jest włączona funkcja zarabiania, określenie cen i planów płatności za usługi interfejsu API. Więcej informacji o zarabianiu znajdziesz w artykule Generowanie przychodu ogółem.
Dostosowywanie portalu dla programistów
Jako dostawca interfejsu API zastanów się, jak dostosować portal dla deweloperów do swoich interfejsów API i dostarczyć społeczności deweloperów niezbędne informacje, aby mogli korzystać z Twoich interfejsów API. Oto kilka kwestii, o których warto pamiętać, tworząc portal niestandardowy:
- Łatwy dostęp do interfejsów API
- dokumentacja, np. przewodniki i dokumenty referencyjne;
- treści tworzone przez społeczność, takie jak blogi i fora dyskusyjne;
- Przykładowy kod
- prosty proces rejestracji, który umożliwia szybkie zatwierdzanie nowych deweloperów, aplikacji i interfejsów API;
- Zarządzane uprawnienia i dane logowania
- Kontrola dostępu na podstawie poziomów
- wygląd i styl pasujący do Twojej organizacji;
Portal jest wstępnie zdefiniowany z podstawową konfiguracją. Na przykład domyślnie portal jest skonfigurowany tak, aby każdy mógł zarejestrować się jako deweloper, ale administrator musi zatwierdzić każdą rejestrację, zanim deweloper będzie mógł zalogować się w portalu. Po zatwierdzeniu rejestracji deweloper może zarejestrować aplikację, aby poprosić o klucz interfejsu API, i korzystać z portalu do uzyskiwania dostępu do zasobów interfejsu API.
Domyślny proces rejestracji składa się z tych kroków:
- Deweloper rejestruje się w portalu dewelopera. W odpowiedzi na to portal wysyła e-maila do administratorów z prośbą o zatwierdzenie konta.
- Administrator zatwierdza konto, a do dewelopera wysyłany jest e-mail z informacją, że może się zalogować.
- Deweloper rejestruje aplikację i wybiera produkty API używane przez aplikację. W odpowiedzi na to portal przypisuje aplikacji unikalny klucz interfejsu API.
- Deweloper przekazuje klucz interfejsu API, gdy wysyła żądania do Twojego interfejsu API.
Gotowe rozwiązanie jest bardzo elastyczne. Możesz na przykład zastąpić domyślny schemat rejestracji i autoryzacji, aby nowy deweloper był automatycznie zatwierdzany i logowany po rejestracji. Możesz też wymagać, aby deweloper zaakceptował określone warunki przed pierwszym zalogowaniem się.
Masz też pełną kontrolę nad treściami dostępnymi w portalu deweloperskim. Na portalu dla deweloperów znajdziesz przykładowe treści, takie jak dokumentacja interfejsu API, posty na blogu i dyskusje na forum. Możesz przesłać własne treści i spersonalizować wygląd każdego typu treści.
Więcej informacji znajdziesz w sekcji Personalizowanie wyglądu.
Administracja portalem dla deweloperów
Deweloperzy korzystają z Twojego portalu dla deweloperów, aby uzyskać dostęp do interfejsu API i z niego korzystać. Administratorzy wykonują czynności związane z zarządzaniem kontem, takie jak:
- dostosowywanie procesu rejestracji deweloperów, w tym pól rejestracji, wbudowanej funkcji captcha oraz zatwierdzania automatycznego lub ręcznego;
- Dodawanie i zatwierdzanie deweloperów. Domyślnie każdy deweloper może zarejestrować się w portalu dla deweloperów, ale musi zostać zatwierdzony przez administratora w interfejsie portalu dla deweloperów. Administratorzy mogą też tworzyć deweloperów bezpośrednio na portalu. Następnie portal automatycznie wysyła e-maila do dewelopera z informacją o utworzeniu konta.
- modyfikowanie konta dewelopera; Na przykład administratorzy mogą zmienić stan konta użytkownika z aktywnego na zablokowane lub zmienić informacje w profilu dewelopera, takie jak nazwa firmy.
- Usuwanie dewelopera. Administratorzy mogą wyłączyć lub usunąć konto dewelopera.
- Przypisywanie ról i uprawnień: administratorzy mogą przypisać określonej roli konto 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 deweloperów
W tabeli poniżej podano podsumowanie funkcji portalu dla deweloperów:
| Funkcja | Szczegóły |
|---|---|
| Obsługa przeglądarek | |
|
Rejestracja użytkownika |
|
|
Zarządzanie użytkownikami |
|
|
Wygląd portalu |
|
|
Zarządzanie treściami i społecznością |
|
|
Uprawnienia |
|
|
Zarządzanie kluczami interfejsu API |
|
|
|
|
|
Blogi |
|
|
Fora |
|
|
Dokumentacja |
|
|
Menu |
|
|
Szukaj |
|
|
Sprawdzenie linków |
|