Zrozumienie organizacji

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X.
informacje.

Organizacja to kontener najwyższego poziomu w Apigee Edge. Zawiera wszystkie Twoje serwery proxy interfejsu API i powiązane zasoby. Pozostała część tego tematu zawiera bardziej szczegółowe informacje o organizacjach, oto kilka praktycznych kwestii:

  • Domyślnie nazwa organizacji znajduje się w adresie URL używanym do wywoływania serwerów proxy interfejsu API, zgodnie z opisem w sekcji Informacje o hostach wirtualnych. Na przykład:
    http(s)://your_org_name-environment.apigee.net/proxy_base_path/...
  • Nazwa organizacji znajduje się w adresie URL interfejsu zarządzania brzegiem sieci. Na przykład ten URL wyświetla serwery proxy interfejsu API dla organizacji docs:

    Pod adresem URL apigee.com/organizations/docs/proxies znajduje się /docs/ w kółku.

  • Być może masz utworzoną tylko jedną organizację, ale możesz należeć do innych organizacji jako użytkownik lub administrator z określonymi uprawnieniami. Jeśli należysz do więcej niż 1 organizacji, w interfejsie zarządzania brzegiem możesz przełączyć się na inną organizację zgodnie z opisem w sekcji Przełączanie się między organizacjami.

  • Gdy wykonujesz wywołania przy użyciu interfejsu API zarządzania jako użytkownik o roli administratora organizacji, organizacja jest wymaganym elementem ścieżki w większości wywołań. Na przykład to żądanie cURL interfejsu API zarządzania zwraca listę wszystkich serwerów proxy interfejsów API w organizacji:
    curl https://api.enterprise.apigee.com/v1/organizations/your_org_name/apis -u org_admin_email_address

Film: obejrzyj krótki film, aby dowiedzieć się, jak organizacje obsługują architekturę środowiska wielu najemców w zakresie zarządzania interfejsami API.

Komponenty organizacji

Gdy tworzysz konto Edge, Edge automatycznie tworzy dla Ciebie organizację. Po utworzeniu możesz dodawać użytkowników do organizacji, tworzyć serwery proxy interfejsów API i usługi API oraz rejestrować deweloperów i aplikacje.

Poniższa ilustracja przedstawia główne komponenty modelu organizacyjnego Edge. Ten model określa sposób, w jaki interfejsy API, usługi API, aplikacje i deweloperzy aplikacji są ze sobą powiązane w Edge.

Schemat blokowy pokazuje, w jaki sposób środowisko, użytkownik, usługa API i programista są powiązane z aplikacją, kluczem interfejsu API/tokenem OAuth i serwerem proxy interfejsu API.

Ten model nie pokazuje wszystkich funkcji Apigee Edge. Jeśli wybierzesz zarabianie, model będzie miał dodatkowe komponenty. Więcej informacji znajdziesz w artykule Generowanie przychodu ogółem. Informacje o zarządzaniu firmami i deweloperami z możliwością zarabiania znajdziesz w artykule Zarządzanie firmami i deweloperami.

Nazwy organizacji

Nazwa organizacji to:

  • Organizacja oceny: username-eval
  • Organizacja płacąca: zdefiniowana przez użytkownika podczas pierwszej obsługi administracyjnej

Po utworzeniu organizacji nie możesz zmienić jej nazwy.

Podczas wysyłania żądania do interfejsu Edge Management API nazwa organizacji staje się częścią adresu URL serwerów proxy interfejsu API i adresu URL. Na przykład typowy adres URL używany do uzyskiwania dostępu do serwera proxy interfejsu API ma postać:

http://org-name-env.apigee.net/v1/weather/forecastrss

gdzie:

  • org-name to nazwa Twojej organizacji.
  • env to środowisko wdrożenia serwera proxy interfejsu API, które jest testowe lub produkcyjne.

Na przykład:

http://myorg-test.apigee.net/v1/weather/forecastrss

Komponenty organizacji

Tabela poniżej zawiera szczegółowe informacje na temat komponentów modelu organizacji:

Komponent Opis

Organizacja

Każde konto Apigee jest mapowane na co najmniej 1 organizację w Apigee Edge. Organizacja zawiera reprezentację wszystkich komponentów, w tym proxy interfejsów API, usług API, pakietów API, aplikacji i deweloperów.

Właściciele kont nie są ograniczeni do jednej organizacji. Niektórzy właściciele kont mogą należeć do wielu organizacji wspierających różne społeczności deweloperów aplikacji lub do nich należeć.

Środowisko Kontekst wykonania w środowisku wykonawczym serwerów proxy API w organizacji. Więcej informacji o środowiskach znajdziesz w sekcji poniżej.

Użytkownik

W organizacji, w której osoba tworząca konto jest automatycznie administratorem, możesz utworzyć więcej użytkowników. Użytkownicy tworzą zespół zajmujący się interfejsami API, w skład którego wchodzą między innymi administratorzy, twórcy usług proxy i interfejsów API oraz użytkownicy monitorujący statystyki i inne statystyki.

Różni użytkownicy mogą mieć różne role i uprawnienia dostępu. Na przykład zdefiniuj niektórych użytkowników jako administratorów organizacji i administratorów operacji z uprawnieniami do modyfikowania organizacji i jej komponentów. Zdefiniuj innych użytkowników z uprawnieniami do tworzenia serwerów proxy interfejsów API i usług API, ale bez uprawnień do modyfikowania innych użytkowników.

Użytkownicy mogą należeć do wielu organizacji. Na przykład Twoja firma może zdefiniować wiele organizacji w Apigee Edge, aby wspierać różne społeczności programistów. Jednak wewnętrznie te same osoby tworzą wszystkie serwery proxy interfejsów API i usługi API, więc należą do wszystkich Twoich organizacji.

Aby zostać użytkownikiem, nie musisz tworzyć konta Apigee (czyli utworzyć organizację Apigee). Administrator może dodać Cię do istniejącej organizacji.

Wszyscy użytkownicy logują się w Apigee Edge tutaj: https://enterprise.apigee.com.

proxy interfejsu API

Użytkownicy w organizacji tworzą co najmniej 1 serwer proxy interfejsu API. Serwer proxy interfejsu API definiuje mapowanie publicznie dostępnego punktu końcowego HTTP na usługę backendu. Serwery proxy interfejsu API można też skonfigurować tak, aby uwzględniały zabezpieczenia (na przykład OAuth), przeprowadzały przekształcanie wiadomości (np. z XML na JSON), ograniczały ruch do usług backendu oraz wykonywać inne cenne operacje na żądaniach, odpowiedziach i wywołaniach usługi.

Edge zbiera dane do analiz na serwerach proxy interfejsów API.

Usługa API

Użytkownicy w organizacji tworzą co najmniej 1 usługę API, gdzie produkt API to pakiet serwerów proxy API połączonych z abonamentem. Ten abonament może określać limity dostępu do proxy interfejsów API, zapewniać bezpieczeństwo, umożliwić monitorowanie i analizy oraz oferować dodatkowe funkcje.

Edge zbiera dane do analiz usług API.

Deweloper

W organizacji jest co najmniej 1 deweloper, który tworzy aplikacje korzystające z interfejsów API (stworzonych w ramach usług API) zdefiniowanych przez Twoją organizację. Deweloperzy korzystają z interfejsów API, ale nie mogą tworzyć interfejsów API ani wykonywać innych czynności w organizacji.

Mogą to być deweloperzy wewnętrzni, partnerzy lub zewnętrzni deweloperzy, którzy płacą za dostęp do interfejsów API.

Deweloperzy muszą zarejestrować się w Twojej organizacji, aby zarejestrować aplikację i otrzymać klucz interfejsu API umożliwiający dostęp do interfejsów API. Jako dostawca interfejsu API to Ty decydujesz, jak dodawać, aktualizować i usuwać programistów w organizacji. Możesz dodać je ręcznie w interfejsie zarządzania brzegiem sieci, utworzyć portal dla programistów, aby zarejestrować je na stronie, lub zdefiniować własny mechanizm rejestracji za pomocą interfejsu Edge Management API.

Deweloper nie musi mieć konta na Edge, a większość deweloperów nie musi wiedzieć nic o Edge. Jeśli deweloper ma konto w Edge, zwykle jest to użytkownik z innej organizacji lub korzysta z usług interfejsu Edge API.

Promująca aplikację

Deweloperzy tworzą co najmniej jedną aplikację kliencką, która korzysta z Twoich interfejsów API.

Deweloperzy muszą zarejestrować swoje aplikacje w Twojej organizacji. Aplikacja w Edge reprezentuje faktyczną aplikację dewelopera. Zapewnia mu klucz interfejsu API, który jest przekazywany przy każdym żądaniu do Twoich interfejsów API.

Wszystkie aplikacje są zarejestrowane w Twojej organizacji, dlatego możesz używać Edge do monitorowania i gromadzenia danych analitycznych dotyczących aplikacji oraz wykorzystania przez nią interfejsów API.

Klucz interfejsu API/token OAuth

W zależności od mechanizmu autoryzacji zdefiniowanego dla interfejsów API aplikacja przekazuje klucz interfejsu API z każdym żądaniem do tych interfejsów. Jeśli ten klucz jest prawidłowy, żądanie jest dozwolone. Edge obsługuje różne typy uwierzytelniania, takie jak prosty klucz interfejsu API, dwuetapowa autoryzacja OAuth, trzyetapowa autoryzacja OAuth.

Jako dostawca interfejsu API musisz określić sposób, w jaki deweloperzy mogą rejestrować swoje aplikacje. Gdy rejestrujesz ich aplikacje, zwracasz deweloperowi klucz wymagany do uzyskania dostępu do interfejsów API.

W momencie rejestracji aplikacji deweloper może wybrać dostęp do 1 lub kilku usług API. Rzeczywista aplikacja dewelopera używa tego samego klucza do uzyskiwania dostępu do wszystkich usług API powiązanych z aplikacją (zarejestrowana reprezentacja aplikacji dewelopera w Edge).

W każdej chwili możesz unieważnić ten klucz, aby aplikacja dewelopera nie miała już dostępu do Twoich interfejsów API (chociaż zarejestrowana reprezentacja aplikacji dewelopera nadal będzie istniała w Twojej organizacji). Możesz też określić limit czasu korzystania z klucza, tak aby deweloper po upływie określonego czasu odświeżał klucz.

Informacje o środowiskach

Środowisko to kontekst wykonywania w środowisku wykonawczym serwerów proxy API w organizacji. Aby uzyskać dostęp do środowiska, musisz wdrożyć w środowisku serwer proxy interfejsu API. Serwer proxy interfejsu API możesz wdrożyć w jednym lub w wielu środowiskach.

Organizacja może zawierać wiele środowisk. Możesz na przykład zdefiniować środowisko dev, test i prod w organizacji.

Organizacja określa zakres niektórych funkcji Apigee. Na przykład dane mapy klucz-wartość (KVM) mogą być udostępniane na poziomie organizacji, co oznacza, że serwery proxy interfejsu API wdrożone w dowolnym środowisku będą otrzymywać te same dane z KVM. Niektóre funkcje, takie jak buforowanie, można ograniczyć do organizacji lub określonego środowiska w organizacji. Dane analityczne Apigee są partycjonowane według kombinacji organizacji i środowiska.

Poniżej znajdują się główne jednostki, którymi zarządzasz w organizacji, w tym te zdefiniowane globalnie w organizacji oraz specjalnie zdefiniowane dla określonego środowiska: