Jak deweloperzy aplikacji korzystają z portalu (wersja oryginalna)

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

Portal dla programistów, który jest już dostępny w pakiecie, umożliwia deweloperom aplikacji rejestrowanie i logowanie się w aplikacjach, które będą korzystać z interfejsów API, oraz zarządzanie nimi.

W tych sekcjach opisano, jak deweloperzy aplikacji mogą korzystać z portalu:

Jak śledzenie rejestracji i logowania dewelopera aplikacji w Edge

Rejestracja dewelopera i logowanie się w portalu są śledzone w Edge za pomocą atrybutu niestandardowego _apiportal.

Gdy deweloper samodzielnie zarejestruje się, do konfiguracji dewelopera zostanie dodany atrybut niestandardowy _apiportal, a stan dewelopera zostanie ustawiony na unverified, co oznacza, że nie zalogował się on w portalu. Przykład: {"status":"unverified","portals":{}}

Gdy deweloper po raz pierwszy loguje się w portalu, atrybut niestandardowy _apiportal jest aktualizowany w celu śledzenia nazwy portalu i czasu dostępu oraz ustawia stan dewelopera na active. Za każdym razem, gdy deweloper loguje się w portalu, atrybut niestandardowy jest aktualizowany w celu zresetowania wartości lastVisit (w formacie epoki) dla tego portalu. Przykład: {"status":"active","portals":{"myorg-myportal":{"lastVisit":1480972935}}}

Rejestrowanie konta dewelopera aplikacji

Aby deweloperzy aplikacji mogli korzystać z Twoich interfejsów API, muszą się zarejestrować, tworząc konto.

Gdy deweloper aplikacji zarejestruje się w portalu:

• Informacje o deweloperze aplikacji są tworzone i przechowywane w Edge. Zobacz Gdzie przechowywane są informacje o koncie dewelopera.
• Deweloper aplikacji pojawia się na liście zarejestrowanych deweloperów aplikacji. Zobacz Poznawanie strony dla deweloperów.

Możesz też zarejestrować deweloperów aplikacji w ich imieniu za pomocą interfejsu Edge zgodnie z opisem w artykule Rejestrowanie deweloperów aplikacji.

Nowi deweloperzy aplikacji mogą samodzielnie zarejestrować się w portalu w ten sposób:

1. Przejdź do portalu.
2. Kliknij Zaloguj się.

3. Kliknij Zarejestruj się.
   Pojawi się poniższe okno.

   

4. Wpisz wymagane informacje (imię, nazwisko i adres e-mail).

5. Kliknij Utwórz.
   Pojawi się poniższe okno.

   

6. Kliknij bezpieczny link w e-mailu, aby otworzyć portal i rozpocząć uwierzytelnioną sesję.

Zaloguj się do portalu

Po zarejestrowaniu się w portalu deweloperzy mogą logować się na stronie logowania.

Za każdym razem, gdy deweloper aplikacji loguje się w portalu, zamiast używać wspólnego obiektu tajnego, takiego jak hasło, do uwierzytelniania dewelopera wysyłany jest bezpieczny link w celu weryfikacji tożsamości i rozpoczęcia sesji w portalu.

Deweloperzy aplikacji mogą logować się w portalu w ten sposób:

1. Przejdź do portalu.
2. Kliknij przycisk Zaloguj się.
3. Wpisz adres e-mail powiązany z kontem.

4. Kliknij Login (Zaloguj się).
   Pojawi się poniższe okno.

   

5. Kliknij bezpieczny link w e-mailu, aby otworzyć portal i rozpocząć uwierzytelnioną sesję.

Zarejestruj aplikacje

Po zalogowaniu się w portalu deweloperzy mogą rejestrować aplikacje korzystające z opublikowanych przez Ciebie usług interfejsu API w ten sposób:

1. W menu użytkowników wybierz Moje aplikacje.
2. Aby utworzyć nową aplikację, kliknij + Aplikacja.
3. Wpisz nazwę i opis aplikacji w oknie Utwórz aplikację.
4. Kliknij Utwórz.
5. Zarządzaj usługami API w aplikacji w sposób opisany poniżej.

Zarządzanie produktami API w aplikacji

Deweloperzy aplikacji mogą zarządzać usługami API w swoich aplikacjach. Usługi interfejsu API zostaną dodane na stronie z informacjami o aplikacji. W przypadku niektórych usług interfejsów API zatwierdzenie nie jest automatyczne. Stan Oczekujący oznacza, że usługa API, do której wysłano prośbę o dostęp, nie została jeszcze przyznana.

Deweloperzy aplikacji mogą zarządzać usługami API w aplikacji z poziomu portalu:

1. W menu użytkowników wybierz Moje aplikacje.
2. Kliknij nazwę aplikacji.
3. Kliknij Zarządzaj produktami.

4. Kliknij przełącznik Dostęp, aby włączyć lub wyłączyć dostęp do usługi API z poziomu aplikacji.

   Uwaga: jeśli deweloper aplikacji wyłączy dostęp do usługi API, która jest prywatna lub tylko wewnętrzna, usługa interfejsu API zostanie usunięta z aplikacji i musi zostać ponownie dodana ręcznie przez administratora portalu zgodnie z opisem w artykule Rejestrowanie aplikacji i zarządzanie kluczami interfejsu API.

5. Kliknij Poproś, aby poprosić o zatwierdzenie usługi interfejsu API, która nie jest jeszcze dozwolona.

6. Kliknij Zapisz.

Wyświetlanie klucza interfejsu API aplikacji

Deweloperzy aplikacji mogą zarządzać kluczem interfejsu API aplikacji z poziomu portalu w ten sposób:

1. W menu użytkowników wybierz Moje aplikacje.
2. Kliknij nazwę aplikacji.
3. Wyświetl klucz interfejsu API w sekcji Klucze.
4. Kliknij Wyświetl obiekt tajny, aby wyświetlić tajny klucz interfejsu API.
5. Potwierdź, że stan klucza interfejsu API to Zatwierdzony.

Rotacja klucza interfejsu API dla aplikacji

Deweloper aplikacji może okresowo wykonywać rotację klucza interfejsu API aplikacji lub w odpowiedzi na potencjalny wyciek lub naruszenie zabezpieczeń. Gdy deweloper aplikacji przeprowadza rotację klucza interfejsu API, tworzony jest nowy klucz interfejsu API z takimi samymi uprawnieniami usługi API co pierwotny klucz. Pierwotny klucz interfejsu API jest oznaczony jako wycofany, ale pozostaje aktywny w czasie jego wycofania z użycia. Aby dane logowania nie zostały zaakceptowane, musisz dezaktywować wycofywany klucz zgodnie z opisem w artykule Dezaktywowanie klucza interfejsu API dla aplikacji.

Deweloperzy aplikacji mogą wykonać rotację podstawowego klucza interfejsu API aplikacji z portalu w ten sposób:

1. W menu użytkowników wybierz Moje aplikacje.
2. Kliknij nazwę aplikacji.
3. W sekcji Klucze umieść kursor nad bieżącym kluczem interfejsu API, aby wyświetlić menu czynności.
4. Kliknij , aby rozwinąć menu czynności.
5. Kliknij Obróć.
6. Kliknij Utwórz w oknie dialogowym, aby potwierdzić operację.
7. Opcjonalnie dezaktywuj klucz interfejsu API w sposób opisany poniżej.

Dezaktywowanie klucza interfejsu API dla aplikacji

Gdy deweloper aplikacji wykonuje rotację klucza interfejsu API zgodnie z opisem w poprzedniej sekcji, klucz interfejsu API jest oznaczony jako wycofany, ale pozostaje aktywny w czasie, gdy wycofujesz go z użycia. Aby dane logowania nie zostały zaakceptowane, musisz dezaktywować wycofywany klucz.

Deweloperzy aplikacji mogą dezaktywować klucz interfejsu API aplikacji w portalu w ten sposób:

1. W menu użytkowników wybierz Moje aplikacje.
2. Kliknij nazwę aplikacji.
3. W sekcji Klucze kliknij Historia kluczy, aby wyświetlić listę wycofanych kluczy.
4. Umieść kursor nad wycofanym kluczem interfejsu API, który chcesz dezaktywować, aby wyświetlić menu czynności.
5. Kliknij , aby rozwinąć menu czynności.
6. Kliknij Dezaktywuj.
7. Kliknij Dezaktywuj, aby potwierdzić operację.
   Stan klucza zostanie zmieniony na Unieważniony.

Edytuj szczegóły aplikacji

Deweloperzy aplikacji mogą edytować szczegóły aplikacji w ten sposób:

1. W menu użytkowników wybierz Moje aplikacje.
2. Kliknij nazwę aplikacji.
3. Zmodyfikuj pola Nazwa lub Opis.
4. Kliknij Zapisz.

Aplikacja zostanie usunięta z listy Moje aplikacje.

Usuń aplikację

Deweloperzy aplikacji mogą usunąć aplikację z portalu w ten sposób:

1. W menu użytkowników wybierz Moje aplikacje.
2. Kliknij nazwę aplikacji.
3. W prawym górnym rogu strony kliknij usuń.

Aplikacja zostanie usunięta z listy Moje aplikacje.