Rejestrowanie aplikacji i zarządzanie kluczami interfejsu API

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

Zarejestruj aplikacje i zarządzaj kluczami interfejsu API zgodnie z opisem w następnych sekcjach.

Wprowadzenie

Rejestracja aplikacji stanowi główny mechanizm kontroli dostępu do interfejsów API.

Jako dostawca interfejsu API tworzysz co najmniej 1 produkt interfejsu API, aby stworzyć pakiet interfejsów API, zgodnie z instrukcjami w artykule Zarządzanie produktami interfejsu API. Podczas rejestrowania aplikacji jej twórca wybiera, których produktów API ma używać, a Edge udostępnia jeden klucz interfejsu API, którego twórca może używać do uzyskiwania dostępu do tych produktów. Programista aplikacji przekazuje klucz interfejsu API w każdym wywołaniu do serwerów proxy interfejsu API zawartych w usługach interfejsu API. W każdej chwili możesz odebrać klucz API aplikacji, uniemożliwiając deweloperowi dostęp do wszystkich lub części produktów API, do których odwołuje się ta aplikacja.

Zwykle deweloperzy aplikacji rejestrują się, aby korzystać z Twoich produktów API, w Twoim portalu dla deweloperów. Instrukcje tworzenia portalu i publikowania usług interfejsu API znajdziesz w artykule Tworzenie portalu.

Jako dostawca interfejsu API możesz też chcieć mieć większą kontrolę nad procesem rejestracji aplikacji i zdecydować się na rejestrowanie aplikacji w Edge, jak opisano w następnych sekcjach. Możesz na przykład zarejestrować aplikacje dla wewnętrznych zespołów programistów lub w imieniu dewelopera bez dostępu do Twojego portalu.

W następnych sekcjach opisujemy, jak rejestrować aplikacje i zarządzać kluczami interfejsu API za pomocą interfejsu użytkownika i interfejsu API.

Poznawanie strony Aplikacje

Otwórz stronę Aplikacje i stosuj się do poniższych instrukcji.

Rejestrowanie aplikacji

Aplikację można zarejestrować na 1 z tych sposobów:

• Deweloper aplikacji może zarejestrować aplikację w Twoim portalu zgodnie z opisem w artykule Jak deweloperzy aplikacji korzystają z Twojego portalu.
• Możesz zarejestrować aplikację w Edge w sposób opisany poniżej. To od Ciebie zależy, jak przekażesz klucz deweloperowi aplikacji.

Zarejestrowane aplikacje są dodawane do:

• Lista zarejestrowanych aplikacji w Edge. Więcej informacji znajdziesz w artykule Wyświetlanie i edytowanie informacji o programiście.
• strona Aplikacje na portalu dewelopera.

Aby zarejestrować aplikację w Edge:

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

   Pole	Opis	Wymagany?
   Nazwa	Nazwa aplikacji. Po utworzeniu aplikacji nie możesz zmienić jej nazwy. Ta nazwa jest używana w wywołaniach interfejsu Management API.	Tak
   Wyświetlana nazwa	Wyświetlana nazwa aplikacji, która pojawia się w interfejsie zarządzania w Edge i na portalu dewelopera.	Nie
   Firma/programista	Uwaga: Apigee hybrid nie obsługuje aplikacji firmowych, więc to pole nie ma zastosowania. Kliknij Firma lub Twórca i w menu wybierz nazwę firmy lub twórcy. Uwaga: ze względu na wydajność nie wszystkie firmy i deweloperzy są wyświetlane w menu. Zacznij wpisywać nazwę firmy lub dewelopera albo adres e-mail w polu wyszukiwania. Zobacz też Rejestracja deweloperów aplikacji.	Tak
   URL wywołania zwrotnego	Zwykle określa adres URL aplikacji, która ma otrzymywać kod autoryzacji w imieniu aplikacji klienta. Ta wartość nie jest wymagana w przypadku wszystkich usług interfejsu API.	Nie
   Uwagi	Opisowe uwagi dotyczące aplikacji.	Nie

4. Podaj dane logowania, w tym datę wygaśnięcia i stan klucza interfejsu API oraz powiązane produkty interfejsu API.
   W sekcji Dane uwierzytelniające kliknij  i podaj te informacje:

   Pole	Opis
   Ważność	Skonfiguruj czas lub datę ważności klucza API albo ustaw, aby klucz nigdy nie tracił ważności, i kliknij OK.
   Produkty	Powiązać z kluczem interfejsu API co najmniej 1 usługę interfejsu API: Kliknij Dodaj produkt. Wybierz co najmniej 1 produkt interfejsu API z listy. Kliknij Dodaj. Ustaw stan na „Zatwierdzony” lub „Odwołany” w przypadku każdego produktu interfejsu API. Powtórz te czynności, aby dodać więcej usług interfejsu API.

5. Podaj atrybuty niestandardowe:
   1. W sekcji Atrybuty niestandardowe kliknij .
   2. Wpisz nazwę i wartość.
   3. Kliknij Dodaj lub Dodaj i uruchom kolejną zasadę.
      Maksymalna liczba atrybutów niestandardowych, które możesz dodać, to 18.
6. Kliknij Utwórz.

Jeśli klucze interfejsu API powiązane z aplikacją wymagają ręcznego zatwierdzenia, zatwierdź je zgodnie z opisem w artykule Zatwierdzanie i odwoływanie kluczy interfejsu API.

Wyświetlanie aplikacji zarejestrowanych przez dewelopera

Aby wyświetlić aplikacje zarejestrowane przez konkretnego dewelopera, użyj jednej z tych metod:

• Wyświetl wszystkie zarejestrowane aplikacje, w menu wyszukiwania kliknij Deweloper, a w polu wyszukiwania wpisz nazwę dewelopera.
• Kliknij Wyświetl wszystkich zarejestrowanych deweloperów aplikacji i wybierz wiersz powiązany z tym 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świetlają się szczegóły aplikacji.
3. Aby edytować aplikację, kliknij Edytuj.
4. Wykonaj co najmniej jedną z tych czynności:
   • Zmień szczegóły aplikacji, w tym nazwę, adres URL wywołania zwrotnego lub notatki.
   • Zarządzaj danymi logowania.
   • Dodawaj i usuwaj atrybuty niestandardowe.
     Maksymalna liczba atrybutów niestandardowych, które możesz dodać, wynosi 18.
   • Zatwierdź lub cofnij aplikację.
5. Kliknij Zapisz.

Zarządzanie danymi logowania

Podczas edytowania aplikacji możesz zarządzać jej poświadczeniami w sekcji Poświadczenia, jak pokazano na rysunku:

Jak widać na poprzednim rysunku, w sekcji Dane logowania możesz wykonać te czynności w interfejsie:

• Wyświetlanie klucza i tajnych kluczy API
• Zatwierdź lub unieważnij klucz interfejsu API dla wszystkich powiązanych usług API lub dla pojedynczej usługi API.
• Zarządzanie produktami interfejsu API w aplikacji
• Wygeneruj nowe dane logowania

Aby zarządzać danymi logowania za pomocą interfejsu API, zapoznaj się z tymi sekcjami:

• Zarządzanie kluczami użytkowników w przypadku aplikacji
• Importowanie istniejących kluczy i kluczy tajnych klienta

Wyświetlanie klucza i tajnego klucza interfejsu API

Aby wyświetlić klucz i tajny klucz API:

1. Otwórz stronę Aplikacje.
2. Kliknij wiersz aplikacji, której klucz API i tajny klucz chcesz wyświetlić.
3. W sekcji Dane logowania kliknij Pokaż obok klucza lub tajnego klucza interfejsu API, który chcesz wyświetlić.

zatwierdzanie lub odwoływanie klucza interfejsu API.

Połączenia API z serwerami proxy 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 produkt interfejsu API zawierający interfejs API.

Możesz skonfigurować produkt interfejsu API, aby automatycznie zatwierdzać klucze interfejsu API zgodnie z opisem w artykule Zarządzanie produktami interfejsu API. Jeśli jednak interfejs API wymaga ręcznego zatwierdzenia kluczy API, musisz ręcznie zatwierdzić klucz.

Możesz cofnąć uprawnienia do klucza API dla wszystkich usług interfejsu API lub tylko jednej z nich. W takim przypadku klucz i klucz tajny 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 interfejsu API. W każdej chwili możesz ponownie zatwierdzić klucz interfejsu API.

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

1. Otwórz stronę Aplikacje.
2. Kliknij w wierszu 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 produktów interfejsu API powiązanych z kluczem API, wybierz Zatwierdzony lub Usunięty powiązany z kluczem API.
   • Aby zatwierdzić lub cofnąć klucz interfejsu API w przypadku konkretnego produktu interfejsu API, w kolumnie Stan wybierz Zatwierdzony lub Cofnięto.
5. Kliknij Zapisz.

Zarządzanie produktami API w aplikacji

Zarządzaj produktami interfejsu 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ć produkt API do aplikacji:

1. Otwórz stronę Aplikacje.
2. Kliknij w wierszu aplikacji, którą chcesz wyświetlić i edytować.
3. Kliknij Edytuj.
4. Wykonaj jedną z tych czynności:
   • Aby dodać produkt interfejsu API do nowego klucza interfejsu API: kliknij , aby wygenerować nowe dane logowania, wybierz datę wygaśnięcia i dodaj produkt interfejsu API do klucza interfejsu API.
   • Aby dodać produkt interfejsu API do istniejącego klucza interfejsu API, w sekcji Dane logowania kliknij Dodaj produkt i wybierz produkt interfejsu API z listy.
5. Kliknij Zapisz.

Usuwanie usługi API z aplikacji

Jeśli chcesz zachować aktywny klucz API, ale nie zezwalać na jego używanie przez produkt API, możesz usunąć go z powiązanych danych logowania.

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

Możesz ponownie dodać usunięty produkt.

Generowanie nowych danych logowania

Możesz wygenerować nowe dane uwierzytelniające dla aplikacji. Jeśli na przykład używasz rotacji kluczy interfejsu API, możesz wygenerować nowe klucze, których termin ważności będzie się pokrywać z terminem ważności kluczy, które po upływie tego terminu nie będą już podlegać rotacji. Możesz też wygenerować nowy klucz/sekret, jeśli bezpieczeństwo oryginalnego klucza/sekretu zostało naruszone. Jeśli wygenerujesz nowy klucz, wszystkie istniejące klucze interfejsu API będą działać do czasu ich wygaśnięcia lub do momentu, gdy je odblokujesz.

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ę wygaśnięcia, dodaj produkty API i ustaw ich stan.
6. Opcjonalnie możesz cofnąć uprawnienia do dowolnego innego klucza API.
7. Kliknij Zapisz.

Zatwierdzanie i odwoływanie aplikacji

.

Zatwierdź lub odrzuć aplikację w sposób opisany poniżej. Gdy cofniesz uprawnienia aplikacji, zatwierdzone klucze interfejsu API nie będą już mogły być używane w wywołaniach interfejsu API w Edge. Po ponownym zatwierdzeniu aplikacji wszystkie zatwierdzone i ważne klucze interfejsu API mogą służyć do wywoływania interfejsu API.

Jeśli aplikacja jest zarejestrowana w innych organizacjach, musisz ją cofnąć w każdej z nich. Może minąć kilka minut, zanim zmiany zostaną rozpoznane przez wszystkie przetwarzacze wiadomości.

Aby zatwierdzić lub cofnąć aplikację:

1. Otwórz stronę Aplikacje.
2. Kliknij w wierszu aplikacji, którą chcesz wyświetlić i edytować.
3. Kliknij Edytuj.
4. W polu Stan aplikacji kliknij Zatwierdź lub Anuluj, aby zatwierdzić lub anulować aplikację.
5. Kliknij Zapisz.

Usuwanie aplikacji

Gdy usuniesz aplikację, wszystkie klucze klienta powiązane z tą aplikacją staną się nieprawidłowe. Użycie nieprawidłowego klucza w żądaniu powoduje jego niepowodzenie.

Jeśli uważasz, że w przyszłości możesz chcieć przywrócić aplikację dewelopera, alternatywą dla jej usunięcia jest wycofanie uprawnień.

Aby usunąć aplikację:

1. Otwórz stronę Aplikacje.
2. Umieść kursor na wierszu aplikacji, którą chcesz usunąć.
3. W kolumnie „Działania” kliknij .

Uwaga: w przypadku Apigee Edge for Public Cloud usuwanie aplikacji dewelopera i powiązanych artefaktów odbywa się asynchronicznie. Aplikacja dewelopera jest usuwana natychmiast, ale zasoby powiązane z tą aplikacją, takie jak klucze aplikacji lub tokeny dostępu, mogą być automatycznie usuwane przez okres od kilku sekund do kilku minut.

Rejestrowanie aplikacji i zarządzanie kluczami interfejsu API za pomocą interfejsu API

Aby zarejestrować aplikacje i zarządzać nimi za pomocą interfejsu API, przeczytaj artykuł Rejestrowanie aplikacji dewelopera. Zapoznaj się też z tymi sekcjami w dokumentacji API:

• Aplikacje
• Aplikacje: firma
• Aplikacje: deweloper
• Klucze aplikacji firmowej
• Klucze aplikacji dla programistów

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