Zrozumienie organizacji

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X.
informacje.

Organizacja jest kontenerem najwyższego poziomu w Apigee Edge. Zawiera wszystkie Twoje serwery proxy interfejsu API i powiązane zasoby. Pozostała część poświęcona jest bardziej szczegółowym informacjom o organizacjach, Oto kilka praktycznych wskazówek:

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

    W adresie URL apigee.com/organizations/docs/proxies znajduje się kółkiem /docs/.

  • Być może została utworzona tylko jedna organizacja, ale możesz należeć do innych organizacji jako użytkownik lub administrator z określonymi uprawnieniami. W interfejsie zarządzania brzegiem, jeśli należysz do więcej niż jednej organizacji, możesz przełączyć się do innej – zgodnie z opisem w sekcji Przełączanie się między organizacjami.

  • Gdy wykonujesz wywołania przy użyciu interfejsu zarządzania API jako użytkownik administratora organizacji jest wymaganym elementem ścieżki w większości wywołań. Na przykład: Żądanie cURL do interfejsu zarządzania API zwraca listę wszystkich serwerów proxy interfejsu 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 wspierają architektura wielu najemców do zarządzania interfejsami API.

Komponenty organizacji

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

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

Schemat blokowy pokazuje, jak są powiązane ze środowiskiem, użytkownikiem, usługą API i deweloperem
    aplikację, klucz API/token OAuth i serwer proxy API.

Ten model nie wyświetla wszystkich funkcji Apigee Edge. Jeśli korzystasz z funkcji zarabiania, model miałby dodatkowe komponenty. Więcej informacji: Generowanie przychodu ogółem Zobacz Zarządzanie firmami i deweloperami .

nazwy organizacji,

Nazwa organizacji:

  • Organizacja oceniająca: username-eval
  • Płatna organizacja: zdefiniowana przez użytkownika podczas wstępnej obsługi administracyjnej.

Po utworzeniu nie możesz zmienić nazwy organizacji.

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

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

gdzie:

  • org-name to nazwa Twojej organizacji.
  • env to środowisko wdrażania serwera proxy interfejsu API, które jest środowiskiem testowym lub produkcja

Na przykład:

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

Komponenty organizacji

W tej tabeli szczegółowo opisano komponenty modelu organizacyjnego:

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 serwerów proxy API, interfejsów API, usług, pakietów API, aplikacji i programistów.

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

Środowisko Kontekst wykonywania środowiska wykonawczego dla serwerów proxy interfejsu API w organizacji. Patrz sekcja poniżej.

Użytkownik

W organizacji, gdzie osoba tworząca konto jest automatycznie administratora, możesz utworzyć więcej użytkowników. Użytkownicy należą do zespołu zajmującego się interfejsami API w organizacji, które mogą obejmować osoby, takie jak administratorzy, serwer proxy API i twórcy usług API, monitorowania statystyk i innych statystyk, a także wiele innych.

Różni użytkownicy mogą mieć różne role i uprawnienia dostępu. Na przykład zdefiniuj niektórzy użytkownicy jako administratorzy organizacji i administratorzy operacji z uprawnieniami aby zmodyfikować organizację i jej składniki. Określ innych użytkowników z uprawnieniami do tworzyć serwery proxy i usługi API, ale bez uprawnień do modyfikowania innych użytkowników.

Użytkownicy mogą należeć do wielu organizacji. Firma może na przykład określić, z różnych organizacji korzystających z Apigee Edge dla różnych społeczności programistów. Wewnętrznie jednak te same osoby tworzą wszystkie serwery proxy i usługi API, członków wszystkich waszych organizacji.

Nie musisz tworzyć konta Apigee, tzn. Apigee użytkownika. Administrator może dodać Cię do istniejącej Twojej 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 mapowania publicznie dostępnego punktu końcowego HTTP na usługę backendu. Serwery proxy interfejsów API mogą też być skonfigurowana tak, aby uwzględniać zabezpieczenia (takie jak OAuth), przeprowadzać przekształcanie wiadomości (np. jako XML do JSON), ograniczaj ruch do usług backendu i wykonuj inne cenne operacje dotyczące żądania, odpowiedzi i wywołań usługi.

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

Usługa API

Użytkownicy w organizacji tworzą co najmniej jedną usługę API, w której To pakiet serwerów proxy API połączonych z abonamentem. Ten abonament umożliwia ustawienie dostępu ograniczenia serwerów proxy interfejsów API, zapewnić bezpieczeństwo, umożliwić monitorowanie i analizę oraz zapewnić funkcje dodatkowe.

Edge gromadzi dane na potrzeby analiz usług API.

Deweloper

W organizacji jest co najmniej jeden programista, który tworzy aplikacje korzystające z Interfejsy API (wbudowane w usługi API) zdefiniowane przez Twoją organizację. Deweloperzy korzystają z interfejsów API ale nie mogą tworzyć interfejsów API ani wykonywać żadnych innych działań w organizacji.

Mogą być wewnętrznie działającymi w Twojej firmie, partnerami lub z zewnątrz, którzy płacą za dostęp do ich interfejsów API.

Aby zarejestrować aplikację, deweloperzy muszą być zarejestrowani w organizacji. otrzymać klucz API umożliwiający dostęp do interfejsów API. Jako dostawca interfejsu API możesz określić, jak dodawać, aktualizować i usuwać deweloperów w organizacji. Możesz dodać je ręcznie w interfejsie zarządzania brzegiem, utwórz portal dla programistów i zarejestruj je strony lub zdefiniować własny mechanizm rejestracji za pomocą zarządzania brzegiem API.

Programista nie musi mieć konta na Edge, a większość deweloperów muszą wiedzieć cokolwiek o Edge. Jeśli deweloper ma konto na Edge, zwykle jako użytkownik w innej organizacji lub aby korzystać z usług interfejsu Edge API.

Promująca aplikację

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

Deweloperzy muszą zarejestrować swoje aplikacje w Twojej organizacji. Aplikacja w Edge jest przedstawia faktyczną aplikację dewelopera i udostępnia mu klucz interfejsu API, dla każdego żądania do interfejsów API.

Wszystkie aplikacje są zarejestrowane w Twojej organizacji, więc za pomocą Edge możesz monitorować zbieranie informacji analitycznych o aplikacji i korzystaniu przez nią z Twoich interfejsów API.

Klucz interfejsu API/token OAuth

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

Jako dostawca interfejsu API musisz określić sposób, w jaki deweloperzy mogą rejestrować swoje aplikacje. Jest rejestrując aplikację, i zwracasz deweloperowi klucz wymagany do uzyskania dostępu API.

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

W każdej chwili możesz unieważnić klucz, aby aplikacja dewelopera nie miała do niego dostępu. do interfejsów API (mimo że zarejestrowana reprezentacja aplikacji dewelopera już istnieje w Twojej organizacji). Można też określić limit czasu dla klucza, musi odświeżyć klucz po określonym czasie.

Informacje o środowiskach

Środowisko to kontekst wykonywania w czasie działania serwerów proxy interfejsów API w organizacji. Musisz wdrożyć w środowisku serwer proxy interfejsu API, aby można było uzyskać do niego dostęp. Możesz wdrożyć interfejs API, przez serwer proxy do jednego lub wielu środowisk.

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

Organizacja udostępnia zakres niektórych możliwości Apigee. Na przykład klucz-wartość mapy (KVM). można udostępnić dane na poziomie organizacji, co oznacza, że serwery proxy interfejsów API wdrożone w pobierze te same dane z KVM. Niektóre funkcje, takie jak buforowanie, mogą mieć ograniczony zakres. w danej organizacji lub w konkretnym środowisku. Dane analityczne Apigee są partycjonowane przez kombinację organizacji i środowiska.

Poniżej znajdują się główne podmioty, którymi zarządzasz w organizacji, w tym te zdefiniowane globalne w organizacji oraz te zdefiniowane specjalnie dla danego środowiska: