Rejestrowanie aplikacji i zarządzanie kluczami interfejsu API

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

Zarejestruj aplikacje i zarządzaj kluczami interfejsu API w sposób opisany w sekcjach poniżej.

Wstęp

Rejestracja aplikacji stanowi główny mechanizm kontrolowania, kto może korzystać z interfejsów API.

Jako dostawca interfejsu API tworzysz co najmniej 1 usługę API, aby powiązać interfejsy API. Więcej informacji znajdziesz w artykule Zarządzanie usługami API. Podczas rejestrowania aplikacji jej deweloper wybiera, których usług interfejsu API ma używać, a Edge udostępnia jeden klucz interfejsu API, za pomocą którego deweloper może uzyskiwać dostęp do tych usług API. Deweloper aplikacji przekazuje klucz interfejsu API w każdym wywołaniu do serwerów proxy interfejsu API zawartych w usługach API. W każdej chwili możesz unieważnić klucz interfejsu API aplikacji, uniemożliwiając deweloperowi dostęp do wszystkich lub podzbioru usług API, do których odwołuje się aplikacja.

Zwykle deweloperzy aplikacji rejestrują się, aby korzystać z usług interfejsu API za pomocą portalu dla programistów. Czynności, które musisz wykonać, aby utworzyć portal i opublikować usługi API, znajdziesz w sekcji Tworzenie portalu.

Jako dostawca interfejsu API możesz też chcieć mieć większą kontrolę nad procesem rejestracji aplikacji i rejestrować aplikacje w Edge zgodnie z opisem w poniższych sekcjach. Możesz na przykład zarejestrować aplikacje dla swoich wewnętrznych zespołów programistycznych lub w imieniu dewelopera bez dostępu do portalu.

W kolejnych sekcjach opisaliśmy, jak rejestrować aplikacje i zarządzać kluczami interfejsu API za pomocą interfejsu i API.

Poznawanie strony Aplikacje

Uzyskiwanie dostępu do strony Aplikacje i jej przeglądanie w sposób opisany poniżej.

Rejestrowanie aplikacji

Aplikację można zarejestrować za pomocą jednej z tych metod:

• Deweloper aplikacji może zarejestrować ją w portalu zgodnie z opisem w sekcji Jak deweloperzy aplikacji korzystają z portalu.
• Możesz zarejestrować aplikację w Edge w sposób opisany poniżej. To Ty decydujesz, jak przekażesz klucz deweloperowi aplikacji.

Zarejestrowane aplikacje zostaną dodane do:

• Lista zarejestrowanych aplikacji w Edge. Zobacz Wyświetlanie i edytowanie informacji dla deweloperów.
• Aplikacje w portalu dla programistów.

Aby zarejestrować aplikację w Edge:

1. Otwórz stronę Aplikacje.
2. Kliknij + Aplikacja.
3. Podaj Szczegóły aplikacji:

   Field	Opis	Wymagana?
   Nazwa	Nazwa aplikacji. Po utworzeniu aplikacji nie można jej już zmienić. Ta nazwa jest używana w wywołaniach interfejsu API zarządzania.	Tak
   Wyświetlana nazwa	Wyświetlana nazwa aplikacji, która będzie widoczna w interfejsie zarządzania brzegiem oraz w portalu dla deweloperów.	Nie
   Firma/deweloper	Uwaga: platforma Apigee hybrydowa nie obsługuje aplikacji firmowych. To pole nie ma zastosowania. Kliknij Firma lub Deweloper i w menu wybierz nazwę firmy lub dewelopera. Uwaga: ze względu na wydajność nie wszystkie firmy i deweloperzy wyświetlają się w menu. Zacznij wpisywać w polu wyszukiwania nazwę firmy, nazwę dewelopera lub adres e-mail. Zobacz też Rejestrowanie deweloperów aplikacji.	Tak
   Adres URL wywołania zwrotnego	Zwykle określa adres URL aplikacji wyznaczonej do otrzymywania kodu autoryzacji w imieniu aplikacji klienckiej. Ta wartość nie jest wymagana w przypadku wszystkich usług API.	Nie
   Uwagi	Opisowe uwagi do aplikacji.	Nie

4. Określ dane logowania, w tym datę ważności i stan klucza interfejsu API oraz powiązane usługi API.
   W sekcji Dane logowania kliknij i podaj te informacje:

   Field	Opis
   Data ważności	Skonfiguruj datę lub okres ważności albo ustaw klucz interfejsu API tak, aby nigdy nie wygasał, i kliknij OK.
   Produkty	Powiąż co najmniej jedną usługę API z kluczem interfejsu API: Kliknij Dodaj produkt. Wybierz z listy co najmniej 1 usługę API. Kliknij Dodaj. Ustaw Stan każdej usługi API na Zatwierdzony lub Unieważniony. Powtórz te czynności, aby dodać więcej usług API.

5. Określ atrybuty niestandardowe:
   1. W sekcji Atrybuty niestandardowe kliknij .
   2. Wpisz nazwę i wartość.
   3. Kliknij Dodaj lub Dodaj i rozpocznij kolejną.
      Możesz dodać maksymalnie 18 atrybutów niestandardowych.
6. Kliknij Utwórz.

Jeśli usługi API powiązane z aplikacją wymagają ręcznego zatwierdzenia kluczy interfejsu API, zatwierdź je w sposób opisany w artykule Zatwierdzanie i unieważnianie kluczy interfejsu API.

Wyświetlanie aplikacji zarejestrowanych dla dewelopera

Aby wyświetlić aplikacje zarejestrowane dla określonego dewelopera, użyj jednej z tych metod:

• Wyświetl wszystkie zarejestrowane aplikacje, w menu Szukaj wybierz Programista i wpisz nazwę dewelopera w polu wyszukiwania.
• Wyświetl wszystkich zarejestrowanych deweloperów aplikacji i kliknij wiersz powiązany z danym deweloperem.

Wyświetlanie i edytowanie aplikacji

Aby wyświetlić i edytować aplikację:

1. Otwórz stronę Aplikacje.
2. Kliknij wiersz aplikacji, którą chcesz wyświetlić i edytować.
   Wyświetlą się szczegóły aplikacji.
3. Aby edytować aplikację, kliknij Edytuj.
4. Wykonaj co najmniej 1 z tych czynności:
   • Zmień szczegóły aplikacji, takie jak jej nazwę, URL wywołania zwrotnego czy notatki.
   • Zarządzaj danymi logowania.
   • Dodaj lub usuń atrybuty niestandardowe.
     Możesz dodać maksymalnie 18 atrybutów niestandardowych.
   • zatwierdzić lub unieważnić aplikację;
5. Kliknij Zapisz.

Zarządzanie danymi logowania

Podczas edytowania aplikacji możesz zarządzać jej danymi logowania w sekcji Dane logowania zgodnie z tym ilustracją:

Jak już wspomnieliśmy na poprzednim ilustracji, w sekcji Dane logowania możesz wykonywać te zadania za pomocą interfejsu użytkownika:

• Wyświetlanie klucza i tajnego klucza interfejsu API
• zatwierdzać lub unieważniać klucz interfejsu API dla wszystkich powiązanych usług API lub tylko dla jednej z nich.
• Zarządzanie usługami API w aplikacji
• Generowanie nowych danych logowania

Informacje o zarządzaniu danymi logowania przy użyciu interfejsu API znajdziesz w tych sekcjach:

• Zarządzanie kluczami klienta dla aplikacji
• Importowanie istniejących kluczy i obiektów tajnych klienta

Wyświetlanie klucza i obiektu tajnego interfejsu API

Aby wyświetlić klucz i tajny klucz interfejsu API:

1. Otwórz stronę Aplikacje.
2. Kliknij wiersz aplikacji, dla której chcesz wyświetlić klucz i tajny klucz interfejsu API.
3. W sekcji Dane logowania kliknij Pokaż powiązane z kluczem lub tajnym kluczem interfejsu API, które chcesz wyświetlić.

Zatwierdzanie i unieważnianie klucza interfejsu API

Wywołania interfejsu API serwerów proxy interfejsu API zwykle wymagają klucza API. Edge zezwala na wywołania tylko wtedy, gdy klucz interfejsu API jest zatwierdzony, prawidłowy i spełnia warunki określone przez usługę API zawierającą ten interfejs API.

Usługę API możesz skonfigurować pod kątem automatycznego zatwierdzania kluczy interfejsu API zgodnie z opisem w artykule Zarządzanie usługami API. Jeśli jednak usługa API wymaga ręcznego zatwierdzenia kluczy interfejsu API, musisz ręcznie zatwierdzić klucz.

Możesz unieważnić klucz interfejsu API dla wszystkich usług API lub dla pojedynczej usługi. W tym przypadku klucz i tajny klucz interfejsu API są nieprawidłowe i nie można ich używać do uzyskiwania dostępu do interfejsów API w powiązanych usługach API. Klucz interfejsu API możesz ponownie zatwierdzić w każdej chwili.

Aby zatwierdzić lub unieważnić klucz interfejsu API:

1. Otwórz stronę Aplikacje.
2. Kliknij wiersz aplikacji, którą chcesz wyświetlić i edytować.
3. Kliknij Edytuj.
4. Wykonaj jedną z tych czynności:
   • Aby zatwierdzić lub unieważnić klucz interfejsu API dla wszystkich usług powiązanych z nim, wybierz Zatwierdzony lub Unieważniony.
   • Aby zatwierdzić lub unieważnić klucz interfejsu API dla określonej usługi, w kolumnie Stan wybierz Zatwierdzony lub Unieważniony.
5. Kliknij Zapisz.

Zarządzanie produktami interfejsu API w aplikacji

Zarządzaj produktami API w aplikacji, wykonując te czynności:

• Dodawanie usługi API do aplikacji
• Usuwanie usługi API z aplikacji

Dodawanie usługi API do aplikacji

Aby dodać usługę API do aplikacji:

1. Otwórz stronę Aplikacje.
2. Kliknij wiersz aplikacji, którą chcesz wyświetlić i edytować.
3. Kliknij Edytuj.
4. Wykonaj jedną z tych czynności:
   • Aby dodać usługę API do nowego klucza interfejsu API, kliknij w celu wygenerowania nowych danych logowania, wybierz eksperyment i dodaj usługę API do klucza interfejsu API.
   • Aby dodać usługę API do istniejącego klucza interfejsu API, w sekcji Dane logowania kliknij Dodaj usługę i wybierz ją z listy.
5. Kliknij Zapisz.

Usuwanie usługi API z aplikacji

Jeśli chcesz, aby klucz interfejsu API był aktywny, ale nie chcesz zezwalać na korzystanie z niego w usłudze interfejsu API, możesz go usunąć z powiązanych danych logowania.

1. Otwórz stronę Aplikacje.
2. Kliknij wiersz aplikacji, którą chcesz wyświetlić i edytować.
3. Kliknij Edytuj.
4. Kliknij obok nazwy usługi API.
5. Kliknij Zapisz.

Usunięty produkt możesz dodać ponownie.

Generuję nowe dane logowania

Możesz generować nowe dane logowania do aplikacji. Jeśli na przykład korzystasz z rotacji kluczy interfejsu API, możesz generować nowe klucze, których daty ważności nakładają się na klucze, które po wygaśnięciu nie będą już w rotacji. Możesz też wygenerować nowy klucz/tajny, jeśli bezpieczeństwo pierwotnego klucza zostanie naruszone. Jeśli wygenerujesz nowy klucz, wszystkie istniejące klucze interfejsu API będą działać do czasu ich wygaśnięcia lub przez Ciebie wyraźnego unieważnienia.

Aby wygenerować nowy klucz interfejsu API:

1. Otwórz stronę Aplikacje.
2. Kliknij wiersz aplikacji, którą chcesz wyświetlić i edytować.
3. Kliknij Edytuj.
4. W sekcji Dane logowania kliknij .
5. Określ datę ważności, dodaj produkty API i ustaw ich stan.
6. Opcjonalnie revoke inne klucze interfejsu API według potrzeb.
7. Kliknij Zapisz.

Zatwierdzanie i unieważnianie aplikacji

.

Zatwierdź lub anuluj aplikację w sposób opisany poniżej. Gdy unieważnisz aplikację, w wywołaniach interfejsu API wysyłanych do Edge nie będzie już można używać zatwierdzonych kluczy interfejsu API. Gdy ponownie zatwierdzisz aplikację, do wywołań interfejsu API będzie można używać wszystkich zatwierdzonych i prawidłowych kluczy interfejsu API.

Jeśli aplikacja jest zarejestrowana w innych organizacjach, musisz ją anulować w każdej z nich. Rozpoznanie zmian przez wszystkie procesory wiadomości może potrwać kilka minut.

Aby zatwierdzić lub unieważnić aplikację:

1. Otwórz stronę Aplikacje.
2. Kliknij wiersz aplikacji, którą chcesz wyświetlić i edytować.
3. Kliknij Edytuj.
4. Wybierz Zatwierdź lub Cofnij w polu Stan aplikacji, aby zatwierdzić lub unieważnić aplikację.
5. Kliknij Zapisz.

Usuwanie aplikacji

Gdy usuniesz aplikację, wszystkie powiązane z nią klucze klienta staną się nieprawidłowe. Użycie nieprawidłowego klucza w żądaniu kończy się niepowodzeniem.

Jeśli wydaje Ci się, że w przyszłości zechcesz przywrócić aplikację dewelopera, zamiast ją usunąć, możesz cofnąć aplikację.

Aby usunąć aplikację:

1. Otwórz stronę Aplikacje.
2. Umieść kursor w wierszu aplikacji, którą chcesz usunąć.
3. Kliknij w kolumnie działań.

Uwaga: w przypadku Apigee Edge dla Public Cloud usuwanie aplikacji dewelopera i powiązanych artefaktów odbywa się asynchronicznie. Aplikacja dewelopera jest usuwana natychmiast, ale automatyczne usunięcie zasobów powiązanych z tą aplikacją, takich jak klucze aplikacji czy tokeny dostępu, może zająć od kilku sekund do kilku minut.

Rejestrowanie aplikacji i zarządzanie kluczami interfejsu API przy użyciu interfejsu API

Informacje o rejestrowaniu aplikacji i zarządzaniu nimi za pomocą interfejsu API znajdziesz w artykule Rejestrowanie aplikacji dla deweloperów. Zapoznaj się też z tymi sekcjami w dokumentacji interfejsu API:

• Aplikacje
• Aplikacje: firma
• Aplikacje: programista
• Klucze aplikacji firmy
• Klucze aplikacji dewelopera

Zobacz też Importowanie istniejących kluczy i obiektów tajnych klienta.