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 zgodnie z opisem w sekcjach poniżej.

Wprowadzenie

Rejestracja aplikacji to podstawowy mechanizm kontrolowania, kto może uzyskiwać dostęp do Twoich interfejsów API.

Jako dostawca interfejsu API tworzysz co najmniej 1 usługę API, aby połączyć interfejsy API w pakiet, jak opisano w sekcji Zarządzanie usługami API. Podczas rejestracji aplikacji deweloper wybiera, których usług API chce używać, a Edge udostępnia mu pojedynczy klucz interfejsu API za pomocą którego może uzyskiwać dostęp do tych usług. Deweloper aplikacji przekazuje klucz interfejsu API w każdym wywołaniu 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 aplikacji dostęp do wszystkich lub części usług API, do których odwołuje się ta aplikacja.

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

Jako dostawca interfejsu API możesz też 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 deweloperskich lub w imieniu dewelopera, który nie ma dostępu do Twojego portalu.

W sekcjach poniżej opisujemy, jak rejestrować aplikacje i zarządzać kluczami interfejsu API za pomocą interfejsu UI i interfejsu API.

Poznawanie strony Aplikacje

Otwórz i poznaj 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 wybierz Opublikuj > Aplikacje.

Wyświetli się strona Aplikacje.

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

Classic Edge (Private Cloud)

Aby otworzyć stronę Aplikacje w interfejsie Classic Edge:

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

Wyświetli się strona Aplikacje deweloperów.

Rejestrowanie aplikacji

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

  • Deweloper aplikacji może zarejestrować aplikację w Twoim portalu, jak opisano w sekcji Jak deweloperzy aplikacji korzystają z Twojego portalu.
  • Aplikację możesz zarejestrować w Edge, jak opisano poniżej. To Ty decydujesz, jak udostępnić klucz deweloperowi aplikacji.

Zarejestrowane aplikacje są dodawane do:

Aby zarejestrować aplikację w Edge:

  1. Otwórz stronę Aplikacje.
  2. Kliknij + Aplikacja.
  3. Określ 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 portalu dla programistów. Nie
    Firma/deweloper

    Uwaga: Apigee Hybrid nie obsługuje aplikacji firmowych. To pole nie ma zastosowania.

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

    		 Tak
    URL wywołania zwrotnego Zazwyczaj 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 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ąż co najmniej 1 usługę API z kluczem interfejsu API:
    1. Kliknij Dodaj usługę.
    2. Wybierz co najmniej 1 usługę API z listy.
    3. Kliknij Dodaj.
    4. Ustaw stan na Zatwierdzony lub Unieważniony w przypadku każdej usługi API.
    5. 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ą.
      Maksymalna liczba atrybutów niestandardowych, które możesz dodać, to 18.
  6. Kliknij Utwórz.

Jeśli usługi API powiązane z aplikacją wymagają ręcznego zatwierdzenia kluczy interfejsu API, zatwierdź je zgodnie z opisem w sekcji Zatwierdzanie i unieważnianie kluczy interfejsu 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 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 zadań:
  5. Kliknij Zapisz.

Zarządzanie danymi logowania

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

Jak widać na ilustracji powyżej, w sekcji Dane logowania możesz wykonywać te czynności za pomocą interfejsu:

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

Wyświetlanie klucza i klucza tajnego interfejsu API

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

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

Zatwierdzanie i unieważnianie 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, prawidłowy i spełnia warunki określone przez usługę API zawierającą interfejs API.

Możesz skonfigurować usługę API tak, aby automatycznie zatwierdzała klucze interfejsu API, jak opisano w sekcji 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 w przypadku wszystkich lub pojedynczej usługi API. 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 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 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 w przypadku wszystkich usług API powiązanych z kluczem interfejsu API, wybierz Zatwierdzony lub Unieważniony obok klucza interfejsu API.
    • Aby zatwierdzić lub unieważnić klucz interfejsu API w przypadku konkretnej usługi API, wybierz Zatwierdzony lub Unieważniony w kolumnie Stan usługi API.
  5. Kliknij Zapisz.

Zarządzanie usługami API w aplikacji

Zarządzaj usługami API w aplikacji, wykonując te czynności:

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 , aby wygenerować nowe dane logowania, wybierz datę wygaśnięcia i dodaj usługę API do klucza interfejsu API.
    • Aby dodać usługę API do dotychczasowego klucza interfejsu API, w sekcji Dane logowania kliknij Dodaj usługę i wybierz usługę API z menu.
  5. Kliknij Zapisz.

Usuwanie usługi API z aplikacji

Jeśli chcesz, aby klucz interfejsu API był aktywny, ale nie chcesz, aby był używany 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 usługi API.
  5. Kliknij Zapisz.

Usuniętą usługę możesz ponownie dodać.

Generowanie nowych danych logowania

Możesz wygenerować nowe dane logowania aplikacji. Jeśli na przykład używasz rotacji kluczy interfejsu API, możesz wygenerować nowe klucze, których data wygaśnięcia pokrywa się z datą wygaśnięcia kluczy, które zostaną wycofane z rotacji. Możesz też wygenerować nowy klucz lub klucz tajny, jeśli bezpieczeństwo oryginalnego klucza lub klucza tajnego 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 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. W razie potrzeby możesz unieważnić inne klucze interfejsu API.
  7. Kliknij Zapisz.

Zatwierdzanie i unieważnianie aplikacji

Zatwierdź lub unieważnij aplikację, jak opisano poniżej. Gdy unieważnisz aplikację, nie będzie można już używać zatwierdzonych kluczy interfejsu API w wywołaniach interfejsu API do Edge. Gdy ponownie zatwierdzisz aplikację, wszystkie zatwierdzone i prawidłowe 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ą unieważnić w każdej z tych organizacji. Zastosowanie zmian 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. Aby zatwierdzić lub unieważnić aplikację, w polu Stan aplikacji wybierz odpowiednio Zatwierdź lub Unieważnij.
  5. Kliknij Zapisz.

Usuwanie aplikacji

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

Jeśli uważasz, że w przyszłości możesz chcieć przywrócić aplikację dewelopera, zamiast ją usuwać, możesz ją unieważnić.

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 Apigee Edge for Public Cloud, usuwanie aplikacji dewelopera i powiązanych z nią 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 potrwać od kilku sekund do kilku minut.

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

Aby rejestrować aplikacje i nimi zarządzać za pomocą interfejsu API, zapoznaj się z sekcją Rejestrowanie aplikacji deweloperów. Zapoznaj się też z tymi sekcjami w dokumentacji API:

Zobacz też Importowanie dotychczasowych kluczy i kluczy tajnych klienta.