Rejestrowanie aplikacji i zarządzanie kluczami interfejsu API

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

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

Wprowadzenie

Rejestracja aplikacji to podstawowy mechanizm kontroli dostępu do interfejsów API.

Jako dostawca interfejsu API tworzysz co najmniej jedną usługę API, aby połączyć interfejsy API w pakiety, zgodnie z opisem w artykule Zarządzanie usługami API. Podczas rejestrowania aplikacji deweloper wybiera, których produktów interfejsu API chce używać, a Edge udostępnia pojedynczy klucz interfejsu API, którego deweloper może używać do uzyskiwania dostępu do tych produktów interfejsu API. Deweloper aplikacji przekazuje klucz interfejsu API w każdym wywołaniu proxy interfejsu API zawartych w usługach API. W każdej chwili możesz cofnąć klucz interfejsu API aplikacji, uniemożliwiając deweloperowi aplikacji dostęp do wszystkich lub części produktów API, do których odwołuje się ta aplikacja.

Zazwyczaj programiści aplikacji rejestrują się, aby korzystać z Twoich usług API, za pomocą portalu dla programistów. Czynności związane z tworzeniem portalu i publikowaniem usług API są opisane w artykule Tworzenie portalu.

Możesz też jako dostawca interfejsu API mieć większą kontrolę nad procesem rejestracji aplikacji i zarejestrować aplikacje w Edge, jak opisano w sekcjach poniżej. Możesz na przykład zarejestrować aplikacje dla wewnętrznych zespołów programistycznych lub w imieniu dewelopera, który nie ma dostępu do Twojego portalu.

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

Przeglądanie strony Aplikacje

Otwórz i przejrzyj stronę Aplikacje w sposób opisany poniżej.

Edge

Aby otworzyć stronę Aplikacje w interfejsie Edge:

  1. Zaloguj się na apigee.com/edge.
  2. Na pasku nawigacyjnym po lewej stronie kliknij Opublikuj > Aplikacje.

Wyświetli się strona Aplikacje.

Jak widać na ilustracji, strona Aplikacje umożliwia:

Nowy interfejs Edge (chmura prywatna)

Aby otworzyć stronę Aplikacje w nowym interfejsie Edge:

  1. Zaloguj się w interfejsie New Edge UI na stronie http://host:3001/edge, gdzie host to adres IP lub nazwa DNS hosta, na którym działa interfejs New Edge UI.
  2. Na pasku nawigacyjnym po lewej stronie kliknij Opublikuj > Aplikacje.

Wyświetli się strona Aplikacje.

Strona Aplikacje w interfejsie nowej wersji Edge

Jak widać na ilustracji, strona Aplikacje umożliwia:

Rejestrowanie aplikacji

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

Zarejestrowane aplikacje są dodawane do:

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żna 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 Edge i na portalu dla programistów. Nie
    Firma/deweloper

    Uwaga: Apigee hybrid nie obsługuje aplikacji firmowych, więc to pole nie ma zastosowania.

    Wybierz Firma lub Deweloper, a potem wybierz nazwę firmy lub dewelopera z menu.
    Uwaga: ze względu na wydajność w menu nie są wyświetlane wszystkie firmy i wszyscy deweloperzy. Wpisz w polu wyszukiwania nazwę firmy, dewelopera lub adres e-mail. Zobacz też Rejestrowanie deweloperów aplikacji.

    		 Tak
    URL wywołania zwrotnego Zwykle określa adres URL aplikacji, która jest przeznaczona do odbierania kodu autoryzacji w imieniu aplikacji klienckiej. Ta wartość nie jest wymagana w przypadku wszystkich usług API. Nie
    Uwagi Opisowe uwagi dotyczące aplikacji. Nie
  4. Określ dane logowania, w tym datę wygaśnięcia i stan klucza interfejsu API oraz powiązane usługi API.
     W sekcji Dane logowania kliknij  i wpisz te informacje:
    Pole Opis
    Data wygaśnięcia Skonfiguruj czas lub datę wygaśnięcia albo ustaw klucz interfejsu API na ważność bezterminową i kliknij OK.
    Produkty Powiąż z kluczem interfejsu API co najmniej 1 produkt interfejsu API:
    1. Kliknij Dodaj produkt.
    2. Wybierz co najmniej 1 produkt interfejsu API z listy.
    3. Kliknij Dodaj.
    4. Ustaw Stan na Zatwierdzony lub Cofnięty w przypadku każdego produktu API.
    5. Powtórz te kroki, aby dodać więcej produktów 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ą.
      Maksymalna liczba atrybutów niestandardowych, które możesz dodać, to 18.
  6. Kliknij Utwórz.

Jeśli produkty interfejsu API powiązane z aplikacją wymagają ręcznego zatwierdzenia kluczy interfejsu API, zatwierdź je zgodnie z instrukcjami w sekcji Zatwierdzanie i unieważnianie kluczy interfejsu API.

Wyświetlanie aplikacji zarejestrowanych przez dewelopera

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

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 jedno z tych zadań:
  5. Kliknij Zapisz.

Zarządzanie danymi logowania

Podczas edytowania aplikacji możesz zarządzać jej danymi logowania w sekcji Dane logowania, jak pokazano na ilustracji poniżej:

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

Aby używać interfejsu API do zarządzania danymi logowania, zapoznaj się z tymi sekcjami:

w interfejsie zarządzania Edge.

Wyświetlanie klucza interfejsu API i klucza tajnego

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

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

Zatwierdzanie lub unieważnianie klucza interfejsu API

Wywołania interfejsu API do proxy interfejsu API zwykle wymagają klucza interfejsu API. Edge zezwala na wywołania tylko wtedy, gdy klucz interfejsu API jest zatwierdzony, ważny i spełnia warunki określone przez usługę API zawierającą interfejs API.

Produkt interfejsu API możesz skonfigurować tak, aby klucze interfejsu API były zatwierdzane automatycznie. Opis znajdziesz w artykule Zarządzanie produktami interfejsu API. Jeśli jednak usługa API wymaga ręcznego zatwierdzania kluczy API, musisz ręcznie zatwierdzić klucz.

Możesz cofnąć klucz API w przypadku wszystkich lub jednego produktu API. W takim przypadku klucz interfejsu API i klucz tajny są nieprawidłowe i nie można ich używać do uzyskiwania dostępu do interfejsów API w powiązanych produktach API. W każdej chwili możesz ponownie zatwierdzić klucz interfejsu API.

Aby zatwierdzić lub cofnąć klucz interfejsu API:

  1. Otwórz stronę Aplikacje.
  2. Kliknij wiersz aplikacji, którą chcesz wyświetlić i edytować.
  3. Kliknij Edytuj.
  4. Wykonaj jedno z tych zadań:
    • Aby zatwierdzić lub cofnąć klucz interfejsu API dla wszystkich usług API powiązanych z tym kluczem, wybierz Zatwierdzono lub Cofnięto obok klucza interfejsu API.
    • Aby zatwierdzić lub cofnąć klucz interfejsu API dla konkretnego produktu API, w kolumnie Stan wybierz Zatwierdzono lub Cofnięto.
  5. Kliknij Zapisz.

Zarządzanie usługami API w aplikacji

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

Dodawanie usługi API do aplikacji

Aby dodać produkt interfejsu API do aplikacji:

  1. Otwórz stronę Aplikacje.
  2. Kliknij wiersz aplikacji, którą chcesz wyświetlić i edytować.
  3. Kliknij Edytuj.
  4. Wykonaj jedno z tych zadań:
    • Aby dodać produkt API do nowego klucza interfejsu API, kliknij , aby wygenerować nowe dane logowania, wybierz datę wygaśnięcia i dodaj produkt 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, aby klucz interfejsu API był aktywny, ale nie chcesz zezwalać na jego używanie przez usługę API, możesz usunąć go 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 produktu interfejsu API.
  5. Kliknij Zapisz.

Usunięty produkt możesz dodać ponownie.

Generowanie nowych danych logowania

Możesz wygenerować nowe dane logowania do aplikacji. Jeśli na przykład używasz rotacji kluczy interfejsu API, możesz wygenerować nowe klucze, których data ważności pokrywa się z datą ważności kluczy, które po wygaśnięciu nie będą już podlegać rotacji. Nowy klucz lub tajny klucz możesz też wygenerować, jeśli bezpieczeństwo pierwotnego klucza lub tajnego klucza zostanie naruszone. Jeśli wygenerujesz nowy klucz, wszystkie dotychczasowe klucze interfejsu API będą nadal działać do momentu wygaśnięcia lub do momentu, gdy je wyraźnie unieważnisz.

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 usługi API i ustaw ich stan.
  6. Opcjonalnie możesz unieważnić inne klucze interfejsu API.
  7. Kliknij Zapisz.

Zatwierdzanie i cofanie zatwierdzenia aplikacji

Zatwierdź lub cofnij dostęp aplikacji zgodnie z poniższymi instrukcjami. Po odwołaniu dostępu aplikacji nie można już używać zatwierdzonych kluczy interfejsu API w wywołaniach interfejsu API do Edge. Gdy ponownie zatwierdzisz aplikację, wszystkie zatwierdzone i ważne klucze interfejsu API będą mogły być używane do wywoływania interfejsów API.

Jeśli aplikacja jest zarejestrowana w innych organizacjach, musisz ją cofnąć w każdej z nich. Zastosowanie tych zmian może zająć kilka minut.

Aby zatwierdzić lub cofnąć dostęp aplikacji:

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

Usuwanie aplikacji

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

Jeśli w przyszłości możesz chcieć przywrócić aplikację dewelopera, zamiast ją usuwać, możesz cofnąć jej uprawnienia.

Aby usunąć aplikację:

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

Uwaga: w przypadku Apigee Edge na chmurę publiczną usuwanie aplikacji dewelopera i powiązanych z nią artefaktów odbywa się asynchronicznie. Aplikacja dewelopera zostanie natychmiast usunięta, ale usunięcie zasobów powiązanych z tą aplikacją, takich jak klucze aplikacji czy tokeny dostępu, może potrwać od kilku sekund do kilku minut.

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

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

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