OAuth 2.0: konfigurowanie nowego serwera proxy interfejsu API

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

Jeśli używasz Edge w Apigee Cloud, zobaczysz, że serwer proxy o nazwie oauth jest domyślnie włączony w Twojej organizacji. Ten serwer proxy udostępnia 2 przykładowe punkty końcowe do generowania tokenów dostępu i odświeżania. Więcej informacji o punktach końcowych tokena OAuth znajdziesz w artykule Omówienie punktów końcowych OAuth.

Typ przyznania danych logowania klienta określa procedurę wydawania tokenów dostępu w zamian za dane logowania do aplikacji. Te dane logowania do aplikacji to para klucza klienta i obiektu tajnego, które Apigee Edge wyświetla w przypadku każdej aplikacji zarejestrowanej w organizacji. Więcej informacji znajdziesz w artykule o implementowaniu typu przyznania kodu autoryzacji.

Dodaj OAuth 2.0 do nowego serwera proxy interfejsu API

Podczas tworzenia nowego serwera proxy API możesz z łatwością dodać do interfejsu API weryfikację OAuth.

Edge

Aby dodać weryfikację OAuth do interfejsu API przy użyciu interfejsu użytkownika Edge:

  1. Zaloguj się na stronie apigee.com/edge.
  2. Na pasku nawigacyjnym po lewej stronie wybierz Programowanie > Proxies API.
  3. Kliknij + Serwer proxy.
  4. Użyj kreatora tworzenia serwera proxy, aby utworzyć odwrotny serwer proxy. Zobacz Tworzenie prostego serwera proxy interfejsu API.
  5. Na stronie Typowe zasady w kreatorze wybierz opcję Protokół OAuth w wersji 2.0.

Klasyczna wersja Edge (Private Cloud)

Aby dodać weryfikację OAuth do interfejsu API przy użyciu klasycznego interfejsu użytkownika Edge:

  1. Zaloguj się w http://ms-ip:9000, gdzie ms-ip to adres IP lub nazwa DNS węzła serwera zarządzania.
  2. Na górnym pasku nawigacyjnym wybierz Interfejsy API > Serwery proxy API.
  3. Kliknij + Serwer proxy API.
  4. Użyj kreatora tworzenia serwera proxy, aby utworzyć odwrotny serwer proxy. Zobacz Tworzenie prostego serwera proxy interfejsu API.
  5. Na stronie Zabezpieczenia w kreatorze wybierz opcję Protokół OAuth w wersji 2.0.

Jeśli wybierzesz tę opcję, do nowo utworzonego serwera proxy interfejsu API zostaną dołączone 2 zasady: jedna do weryfikowania tokenów dostępu i druga do usuwania tokena dostępu po jego zweryfikowaniu.

Pamiętaj, że pole wyboru Opublikuj usługę API będzie można wybrać i będzie zaznaczone automatycznie. Zaznacz tę opcję, jeśli chcesz automatycznie generować usługę podczas tworzenia nowego serwera proxy interfejsu API. Zostanie utworzona automatycznie usługa, która powiąże ją z nowym serwerem proxy interfejsu API. Jeśli masz już usługę, z którą chcesz powiązać ten nowy interfejs API, usuń zaznaczenie tego pola wyboru, aby nie utworzyć zbędnej usługi. Informacje o produktach znajdziesz w artykule „Co to jest usługa API?”.

Praca z domyślnym serwerem proxy OAuth

Serwer proxy OAuth ujawnia ten identyfikator URI punktu końcowego:

/oauth/client_credential/accesstoken

Opublikuj ten identyfikator URI deweloperom, którzy muszą uzyskać tokeny dostępu. Deweloperzy aplikacji konfigurują w aplikacjach wywoływanie tego punktu końcowego, przedstawiając swoje pary klucza i tajnego klucza klienta w celu uzyskania tokenów dostępu.

Domyślny punkt końcowy tokena danych logowania klienta jest widoczny w sieci pod tym adresem URL:

https://{org_name}-{env_name}.apigee.net/oauth/client_credential/accesstoken

Jeśli na przykład nazwa Twojej organizacji to „apimakers”, adres URL będzie miał postać:

https://apimakers-test.apigee.net/oauth/client_credential/accesstoken

To adres URL, który programiści wywołują, aby uzyskać tokeny dostępu.

Wywoływanie interfejsu API

Po otrzymaniu tokena dostępu możesz wywołać interfejs API z nagłówkiem autoryzacji i tokenem okaziciela w ten sposób:

curl -H "Authorization: Bearer <your access token>" http://myorg-myenv.apigee.net/myapi

Więcej informacji znajdziesz w sekcji Weryfikowanie tokenów dostępu.