Rejestrowanie aplikacji i zarządzanie kluczami interfejsu API

Wyświetlasz dokumentację Apigee Edge.
Zapoznaj się z dokumentacją Apigee X. info

Zarejestruj aplikacje i zarządzaj kluczami interfejsu API zgodnie z opisem w sekcjach poniżej.

Wprowadzenie

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

Jako dostawca interfejsu API tworzysz co najmniej 1 produkt API, aby połączyć interfejsy API w pakiet, zgodnie z opisem w artykule Zarządzanie produktami API. Podczas rejestrowania aplikacji deweloper wybiera, z których usług API chce korzystać, a Edge udostępnia jeden klucz API, którego deweloper może używać do uzyskiwania dostępu do tych usług API. Programista aplikacji przekazuje klucz interfejsu API w każdym wywołaniu serwerów proxy interfejsu API zawartych w usługach API. W dowolnym momencie możesz cofnąć klucz 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 deweloperzy aplikacji rejestrują się, aby korzystać z Twoich produktów API, za pomocą portalu dla programistów. Instrukcje tworzenia portalu i publikowania usług API znajdziesz w artykule Tworzenie portalu.

Możesz też jako dostawca interfejsu API mieć większą kontrolę nad procesem rejestracji aplikacji i zarejestrować je w Edge, jak opisano w sekcjach poniżej. Możesz na przykład zarejestrować aplikacje dla wewnętrznych zespołów deweloperskich 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.

Poznaj stronę Aplikacje

Otwórz i przejrzyj stronę Aplikacje, jak opisano 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 rysunku, na stronie Aplikacje możesz:

Classic Edge (Private Cloud)

Aby otworzyć stronę Aplikacje w klasycznym interfejsie Edge:

  1. Zaloguj się w http://ms-ip:9000, gdzie ms-ip to adres IP lub nazwa DNS węzła serwera zarządzającego.
  2. Na pasku nawigacyjnym u góry kliknij Opublikuj > Aplikacje dewelopera.

Wyświetli się strona Aplikacje dewelopera.

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ć nazwy. Ta nazwa jest używana w wywołaniach interfejsu Management API. Tak
    Wyświetlana nazwa Nazwa wyświetlana aplikacji, która pojawia się w interfejsie zarządzania Edge i na portalu dewelopera. 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. Zacznij wpisywać nazwę firmy, dewelopera lub adres e-mail w polu wyszukiwania. 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 klienta. 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
    Ważność Skonfiguruj czas lub datę wygaśnięcia albo ustaw klucz interfejsu API jako nigdy niewygasający i kliknij OK.
    Produkty Powiąż z kluczem interfejsu API co najmniej 1 produkt interfejsu API:
    1. Kliknij Dodaj produkt.
    2. Wybierz co najmniej jedną usługę API z listy.
    3. Kliknij Dodaj.
    4. Ustaw Stan na Zatwierdzony lub Cofnięty w przypadku każdego produktu API.
    5. Aby dodać więcej produktów interfejsu API, powtórz te czynności.
  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 API powiązane z aplikacją wymagają ręcznego zatwierdzenia kluczy API, zatwierdź je zgodnie z instrukcjami w artykule Zatwierdzanie i unieważnianie kluczy API.

Wyświetlanie aplikacji zarejestrowanych przez dewelopera

Aby wyświetlić aplikacje zarejestrowane przez 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 w wierszu 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ć w interfejsie te czynności:

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

Wyświetlanie klucza interfejsu API i tajnego klucza

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

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

Zatwierdzanie lub wycofywanie klucza interfejsu API

Wywołania interfejsu API do serwerów 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 produkt API zawierający interfejs API.

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

Możesz cofnąć klucz interfejsu API dla 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 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 API powiązanych z tym kluczem, wybierz Zatwierdzony lub Unieważniony obok klucza interfejsu API.
    • Aby zatwierdzić lub cofnąć klucz interfejsu API dla konkretnej usługi 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 w wierszu aplikacji, którą chcesz wyświetlić i edytować.
  3. Kliknij Edytuj.
  4. Wykonaj jedną z tych czynności:
    • 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 menu.
  5. Kliknij Zapisz.

Usuwanie usługi API z aplikacji

Jeśli chcesz, aby klucz API pozostał aktywny, ale nie był używany 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 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 okres ważności pokrywa się z okresem ważności kluczy, które po wygaśnięciu nie będą już podlegać rotacji. Nowy klucz lub sekret możesz też wygenerować, jeśli bezpieczeństwo pierwotnego klucza lub sekretu 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 cofniesz.

Aby wygenerować nowy klucz interfejsu API:

  1. Otwórz stronę Aplikacje.
  2. Kliknij w wierszu 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. W razie potrzeby możesz unieważnić inne klucze interfejsu API.
  7. Kliknij Zapisz.

Zatwierdzanie i cofanie dostępu aplikacji

Zatwierdź lub unieważnij aplikację w sposób opisany poniżej. Gdy cofniesz dostęp aplikacji, zatwierdzone klucze interfejsu API nie będą już mogły być używane 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 interfejsu API.

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

Aby zatwierdzić lub unieważnić 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 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 publikację.

Aby usunąć aplikację:

  1. Otwórz stronę Aplikacje.
  2. Ustaw 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 i zarządzaniu nimi za pomocą interfejsu API znajdziesz w artykule Rejestrowanie aplikacji związanych z programistami. Zapoznaj się też z tymi sekcjami w dokumentacji interfejsu API:

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