Komunikacja między portalem opartym na Drupal a Edge

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

Portal usług dla programistów jest klientem Apigee Edge. Oznacza to, że portal nie działa jako samodzielny system. Zamiast tego większość informacji używanych przez portal jest w rzeczywistości przechowywana w Edge. W razie potrzeby portal wysyła żądanie HTTP lub HTTPS, aby pobrać informacje z Edge lub wysłać je do Edge.

Edge nie wysyła żądań do portalu, odpowiada tylko na żądania wysyłane z portalu. Dlatego wszystkie interakcje między portalem a Edge są inicjowane przez portal.

Skonfiguruj połączenie między portalem a Edge

Istnieją 3 informacje, które portal musi komunikować się z Edge.

  • Adres URL punktu końcowego Edge

    Domyślnym punktem końcowym Edge działającej w chmurze jest https://api.enterprise.apigee.com/v1.

    W przypadku instalacji Private Cloud adres URL ma postać: http://EdgePrivateCloudIp:8080/v1 lub https://EdgePrivateCloudIp:TLSport/v1.

    Gdzie EdgePrivateCloudIp to adres IP serwera zarządzania brzegiem, a TLSport to port TLS/SSL dla interfejsu Edge Management API. Na przykład: 8443.
  • Nazwa organizacji Apigee

    Jest to nazwa Twojej organizacji w Edge. Konfigurujesz organizację podczas tworzenia konta w Edge.
  • Nazwa użytkownika i hasło administratora dewelopera

    Wywołania z portalu do Edge są uwierzytelnione i wymagają użytkownika z uprawnieniami administratora dewelopera. Po udostępnieniu Ci portalu dla programistów do Twojej organizacji zostanie dodana rola Administrator programisty. Ta rola, która obejmuje jednego użytkownika o nazwie devadmin+{org_name}@apigee.com, służy wyłącznie do połączenia portalu dla programistów z organizacją Edge. Ponieważ w portalu wyświetlane są aplikacje programisty Edge, usługi interfejsu API itp., musi on być zsynchronizowany z organizacją Edge przez wykonywanie wywołań interfejsu API zarządzania, które wymagają uwierzytelniania. „Użytkownik” devadmin ma niezbędne uprawnienia.

Aby wyświetlić informacje o połączeniu:

  1. W menu administrowania Drupal wybierz Configuration > Dev Portal > Application Settings (Konfiguracja > Portal dla programistów > Ustawienia aplikacji).

Aby zmienić konfigurację:

Sposób zmiany konfiguracji zależy od instalacji portalu i jego wersji:

  • Instalacja portalu w chmurze w wersji 15.01.06 i nowszej: musisz wysłać żądanie do działu pomocy Apigee Edge, aby zmienić informacje o połączeniu. Jeśli na przykład chcesz zmienić nazwę organizacji.
  • Instalacja lokalna i portal w chmurze w wersji starszej niż 15.01.06: zmień informacje o połączeniu w sposób opisany poniżej:
  1. W menu administrowania Drupal wybierz Configuration > Dev Portal Settings (Konfiguracja > Ustawienia portalu dla programistów).
  2. Wpisz nazwę organizacji w polu Organizacja interfejsu API zarządzania Google Analytics.
  3. Wpisz adres URL punktu końcowego Edge w polu Management API Endpoint URL (Adres URL punktu końcowego interfejsu Management API).
  4. Wpisz dane logowania administratora organizacji w polach Użytkownik uwierzytelniony w punkcie końcowym i Hasło użytkownika uwierzytelnionego.
  5. Kliknij Test Connection (Testuj połączenie), aby sprawdzić, czy połączenie jest udane.
  6. Kliknij Save Configuration (Zapisz konfigurację).

Zapewnianie dostępu do Edge z portalu

Ponieważ większość informacji używanych przez portal jest przechowywana w Edge, musisz się upewnić, że portal ma dostęp do Edge. Portal inicjuje komunikację z Edge, wysyłając żądania REST przez HTTP i HTTPS. Jeśli na przykład deweloper zarejestruje nową aplikację w portalu, portal wyśle do Edge żądanie wysłania informacji o aplikacji.

Zarówno Edge, jak i portal można wdrożyć w chmurze lub lokalnie. Możesz mieszać typy wdrożeń. Możesz na przykład wdrożyć oba te rozwiązania w chmurze, lokalnie lub lokalnie:

  • Jeśli portal i Edge są wdrożone przez Apigee w chmurze, nie powinny występować problemy z wysyłaniem żądań z portalu do Edge.
  • Jeśli wdrażasz portal lokalny, musisz się upewnić, że może on wysyłać żądania do Edge niezależnie od tego, czy Edge jest ona wdrożona w chmurze czy lokalnie.
  • Jeśli wdrażasz Edge w środowisku lokalnym, musisz upewnić się, że portal ma dostęp do Edge. Oznacza to, że serwer graniczny musi akceptować żądania z portalu niezależnie od tego, czy jest on wdrożony w chmurze, czy lokalnie.

Film: obejrzyj krótki film, aby dowiedzieć się więcej o tym, jak portal dla programistów komunikuje się z Apigee Edge i aby upewnić się, że połączenie działa.

Zarządzanie aplikacjami i kluczami interfejsu API z portalu

Gdy deweloper zakończy proces rejestracji aplikacji w portalu, portal wyśle do Edge informacje o aplikacji, w tym jej nazwę i powiązane z nią usługi API.

Jeśli Edge prawidłowo zarejestruje aplikację, Edge zwróci do portalu pojedynczy klucz interfejsu API. Następnie za pomocą tego klucza interfejsu API deweloper uzyskuje dostęp do usług API powiązanych z aplikacją.

W portalu nie są przechowywane żadne informacje o aplikacjach i kluczach interfejsu API. Zamiast tego wszystkie te informacje są przechowywane w Edge. Dlatego za każdym razem, gdy deweloper użyje portalu do wyświetlenia informacji o aplikacji, wyśle on do Edge żądanie dostępu do tych informacji. Za każdym razem, gdy deweloper modyfikuje aplikację, portal automatycznie wysyła te zmiany do Edge.

Na przykład programista loguje się w portalu i przechodzi na stronę Moje aplikacje. Aby zapełnić stronę Moje aplikacje, portal wysyła do Edge żądanie pobrania informacji o aplikacjach i kluczach interfejsu API dewelopera. Te informacje pojawią się w portalu na stronie Moje aplikacje w portalu:

Jeśli następnie deweloper doda, usunie lub zmieni aplikację, portal wyśle te zmiany do Edge.

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

  • Dodawanie, usuwanie i modyfikowanie aplikacji dewelopera
  • Unieważnianie i zatwierdzanie klucza interfejsu API dla aplikacji

Poniżej widać tę samą aplikację – „My Weather App” (Aplikacja Moja pogoda), którą administrator widzi w interfejsie Edge:

Zarządzanie deweloperami z portalu

Gdy deweloper rejestruje się jako nowy użytkownik portalu, tworzony jest jego deweloper w Edge i portalu. Dlatego w przeciwieństwie do aplikacji i kluczy interfejsu API informacje o programistach są przechowywane zarówno w Edge, jak i w portalu.

Informacje o deweloperze przechowywane w Edge obejmują:

  • Imię
  • Nazwisko
  • adres e-mail,
  • Opcjonalne dodatkowe informacje wysyłane z portalu

Portal zawiera te same informacje co Edge, ale zawiera też dodatkowe informacje, takie jak:

  • Hasło do portalu
  • Stan konta w portalu: aktywny lub zablokowany
  • Rola w portalu: uwierzytelniony użytkownik, administrator, inna osoba
  • Uprawnienia oparte na rolach: określaj, jakie działania deweloper może wykonywać w portalu

Gdy deweloper loguje się w portalu, to portal odpowiada za uwierzytelnianie dewelopera i egzekwowanie uprawnień opartych na rolach.

Portal zawiera wszystkie informacje o programiście, dlatego należy traktować go jako system rejestrowania informacji o deweloperze, a nie za Edge. Gdy deweloper zmieni swoje informacje w portalu, zostaną one zapisane w portalu i (w stosownych przypadkach) przesłane do Edge. Jeśli na przykład deweloper zmieni swoje imię, te informacje zostaną przesłane do Edge. Jeśli jednak deweloper zmieni hasło, te informacje będą przechowywane tylko lokalnie w portalu.

Więcej informacji znajdziesz w artykule Dodawanie kont użytkowników i zarządzanie nimi.

Synchronizowanie programistów aplikacji między portalem a Edge

Edge nie inicjuje komunikacji z portalem. Jeśli jako administrator Edge modyfikujesz informacje o programiście w interfejsie Edge, nie ma gwarancji, kiedy zostaną one przekazane do portalu. Dlatego do tworzenia, modyfikowania i usuwania programistów używaj funkcji administracyjnych portalu, a nie Edge.

Administrator portalu może wymusić synchronizację między portalem a Edge, aby pobrać informacje do portalu z Edge. Jeśli jednak modyfikujesz programistów tylko w portalu, a nie w Edge, nie musisz nigdy wykonywać tej synchronizacji. Poza tym Edge nie pozwala na ustawienie hasła podczas tworzenia programisty, dlatego w przypadku każdego programisty utworzonego w Edge może ustawić losową wartość. Dlatego przed zalogowaniem się w portalu deweloper musi przejść proces odzyskiwania hasła.

Synchronizowanie portalu z deweloperami aplikacji w Edge

  • Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub z uprawnieniami do tworzenia treści.
  • W menu administrowania Drupal wybierz Osoby.
  • Wybierz przycisk Synchronizacja programistów portalu dla programistów u góry strony, aby zsynchronizować dane z deweloperami aplikacji w Edge.