Część 2. Wygeneruj i przetestuj klucz interfejsu API

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

Zmieniono strukturę i przekierowano do Zabezpieczanie interfejsu API przez wymaganie kluczy interfejsu API.

Deweloper tworzy aplikację, która wysyła żądania do Twoich interfejsów API, aby uzyskać dostęp do usług backendu. Aby kontrolować dostęp do interfejsów API, możesz wymagać, aby deweloper przekazywał klucz interfejsu API w każdym żądaniu. Jeśli klucz jest nieprawidłowy lub go brakuje, żądanie się nie powiedzie.

Publikowanie to proces udostępniania interfejsów API deweloperom aplikacji w celu ich użycia. Publikowanie interfejsów API można ogólnie zdefiniować za pomocą tych zadań:

1. Utwórz usługi API w Apigee Edge, które łączą Twoje interfejsy API.
2. Zarejestruj deweloperów aplikacji w Edge. Tylko zarejestrowany deweloper aplikacji może zarejestrować aplikację.
3. Deweloperzy rejestrują aplikacje w Edge, aby uzyskać dostęp do usług API. W odpowiedzi deweloper otrzymuje klucz interfejsu API. Gdy deweloper ma klucz interfejsu API, może wysyłać żądania do Twoich interfejsów API.

Więcej informacji znajdziesz w artykule Wprowadzenie do publikowania.

W tabeli poniżej znajdziesz definicje niektórych terminów używanych do rejestrowania aplikacji i generowania kluczy:

Wymagania wstępne dotyczące tego samouczka

W tym samouczku zakładamy, że masz już za sobą pierwszy samouczek, w którym tworzysz serwer proxy interfejsu API umożliwiający dostęp do interfejsu Yahoo Weather API. Jeśli nie masz jeszcze za sobą pierwszego samouczka, przeczytaj Zabezpieczanie interfejsu API przez wymaganie kluczy interfejsu API.

Krok 1. Utwórz usługę API

1. W interfejsie zarządzania kliknij kartę Opublikuj , a następnie Usługi.
2. Kliknij (+) Usługa.
3. W oknie Dodaj usługę wpisz lub wybierz te wartości:

   Pole	Wartość
   Nazwa	Bezpłatna usługa API
   Wyświetlana nazwa	Bezpłatna usługa API
   Opis	Bezpłatna usługa API
   Środowisko	test
   Dostęp	Tylko na użytek wewnętrzny
   Typ zatwierdzenia klucza	Automatyczny (klucz interfejsu API jest automatycznie zatwierdzany po wygenerowaniu)
   Quota	10 żądań na 1 godzinę (ogranicza liczbę żądań do 10 na godzinę)
   Dozwolone zakresy OAuth	pozostaw puste

   Wypełnione okno powinno wyglądać tak:

   

4. W sekcji Zasoby wybierz:
   • Serwer proxy interfejsu API: weatherapikey
   • Wersja: 1
   • Ścieżka zasobu: /forecastrss**
     
     Ścieżka zasobu określa identyfikatory URI zasobów, do których usługa umożliwia dostęp aplikacji. W tym przykładzie aplikacja może uzyskać dostęp tylko do zasobu /forecastrss w serwerze proxy weatherapikey za pomocą tej usługi API. Próba użycia tej usługi API do uzyskania dostępu do dowolnego innego zasobu w serwerze proxy weatherapiproxy lub w dowolnym innym serwerze proxy jest zabroniona.
     
     W ścieżce zasobu można używać symboli wieloznacznych. Symbol wieloznaczny "/**" oznacza, że uwzględniane są wszystkie podrzędne identyfikatory URI, czyli zasób w postaci /forecastrss/foo/bar. Symbol wieloznaczny „/” oznacza, że uwzględniane są tylko identyfikatory URI o 1 poziom niżej. uwzględnione. Więcej informacji znajdziesz w artykule Tworzenie usług API produktów.
     
     Pamiętaj, że lista rozwijana Ścieżka zasobu zawiera wszystkie przepływy warunkowe zdefiniowane w określonym serwerze proxy interfejsu API. Przepływ warunkowy serwera proxy interfejsu API określa logikę lub kroki przetwarzania powiązane ze ścieżką zasobu. Usługa API kontroluje dostęp do tych ścieżek zasobów.
     
5. Kliknij Importuj zasób. Ścieżka zasobu zostanie dodana, a serwer proxy interfejsu API weatherapikey zostanie automatycznie dodany do sekcji Serwery proxy interfejsu API dla usługi.
6. Kliknij Zapisz. Nowa usługa pojawi się na stronie Usługi.

Więcej informacji:

• Tworzenie usług API

Krok 2. Zarejestruj dewelopera

Aby wygenerować klucz interfejsu API, zarejestruj aplikację i powiąż ją z usługą API. Nie możesz jednak zarejestrować aplikacji bez wcześniejszego zarejestrowania dewelopera.

1. W interfejsie zarządzania kliknij kartę Opublikuj , a następnie Deweloperzy.
2. Kliknij (+) Deweloper.
3. W oknie Nowy deweloper wpisz te wartości:
   • Imię: Jane
   • Nazwisko: Tutorial
   • Adres e-mail: janetutorial@example.com
   • Nazwa użytkownika: jtutorial
4. Kliknij Zapisz. Nowy deweloper pojawi się na liście deweloperów na stronie Deweloperzy.

Więcej informacji:

• Zarządzanie deweloperami aplikacji

Krok 3. Zarejestruj aplikację

Gdy masz już usługę API i dewelopera, możesz zarejestrować aplikację w usłudze API API. Zarejestrowanie aplikacji generuje klucz interfejsu API dla usług API powiązanych z aplikacją. Możesz wtedy udostępnić klucz deweloperom aplikacji, aby mogli oni uzyskiwać dostęp do funkcji w usługach API produktów z poziomu aplikacji.

1. W interfejsie platformy API kliknij kartę Opublikuj, a następnie Aplikacje deweloperów.
2. Kliknij (+) Aplikacja dewelopera.
3. W oknie Dodaj aplikację wpisz te wartości:
   • Wyświetlana nazwa: Weather API Key App
   • Deweloper: Jane Tutorial (janetutorial@example.com)
   • Callback URL: pozostaw puste
4. Powiąż aplikację z usługą:
   1. W sekcji Usługi kliknij + Usługa.
   2. Wybierz Bezpłatna usługa API.
   3. Aby zaakceptować zmiany, kliknij ikonę haczyka.
5. Kliknij Zapisz. Nowa aplikacja pojawi się na liście aplikacji na stronie Aplikacje deweloperów.
6. Na liście aplikacji wybierz Weather API Key App. Otworzy się strona z informacjami o aplikacji.
7. Ponieważ podczas tworzenia usługi API wybrano Typ zatwierdzenia klucza: Automatyczny, klucz interfejsu API jest automatycznie zatwierdzany i możesz go od razu wyświetlić. (Jeśli wybrano Typ zatwierdzenia: Ręczny, aby zatwierdzić klucz interfejsu API, musisz kliknąć Zatwierdź w kolumnie Działania w przypadku bezpłatnej usługi API).
8. W sekcji Usługi obok pozycji Bezpłatna usługa API kliknij Pokaż w kolumnach Klucz klienta i Tajny klucz klienta , aby wyświetlić wygenerowane klucze.
   

   Klucz klienta to inna nazwa klucza interfejsu API. Jest to jedyny klucz, którego aplikacja potrzebuje, aby uzyskać dostęp do zasobu prognozy za pomocą serwera proxy interfejsu API. Tajny klucz klienta jest potrzebny (wraz z kluczem klienta) do zabezpieczenia interfejsu API za pomocą OAuth 2.0. Zobacz na przykład OAuth 2.0: konfigurowanie nowego serwera proxy interfejsu API.

Więcej informacji:

• Rejestrowanie aplikacji i zarządzanie kluczami interfejsu API.

Krok 4. Użyj klucza interfejsu API w żądaniu

Aby sprawdzić, czy zasada VerifyAPIKey działa prawidłowo, musisz ją przetestować, wywołując serwer proxy interfejsu API za pomocą prawidłowego klucza interfejsu API. Możesz wysłać żądanie do serwera proxy interfejsu API w przeglądarce, na stronie Śledzenie serwera proxy interfejsu API, w konsoli Apigee lub za pomocą cURL. Adres URL żądania ma postać:

http://{org-name}-test.apigee.net/v1/weatherapikey/forecastrss?w=12797282&apikey=IEYRtW2cb7A5Gs54A1wKElECBL65GVls

Zastąp {org-name} nazwą organizacji Apigee i podaj prawidłową wartość apikey.

W odpowiedzi poszukaj tych treści:

<rss xmlns:yweather="http://xml.weather.yahoo.com/ns/rss/1.0" xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" version="2.0"> 
<channel> <title>Yahoo! Weather - Palo Alto, CA</title> 
<link>http://us.rd.yahoo.com/dailynews/rss/weather/Palo_Alto__CA/*http://weather.yahoo.com/forecast/USCA1093_f.html</link> 
<description>Yahoo! Weather for Palo Alto, CA</description> <language>en-us</language>

Jeśli pominiesz klucz interfejsu API w żądaniu lub podasz nieprawidłową wartość klucza, otrzymasz odpowiedź o błędzie w postaci:

{"fault":{"faultstring":"Failed to resolve API Key variable null","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

Krok 5. Co dalej?

Gdy wyślesz żądanie do interfejsu API za pomocą parametru zapytania, aby przekazać klucz interfejsu API, zmodyfikuj interfejs API, aby przekazywał klucz jako nagłówek.