Interakcja użytkowników z portalem

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

Portal dla programistów umożliwia użytkownikom portalu tworzenie kont użytkowników, logowanie się i zarządzanie aplikacjami, które będą korzystać z Twoich interfejsów API.

W sekcjach poniżej opisujemy, jak użytkownicy portalu korzystają z Twojego portalu.

Logowanie się w portalu

W sekcjach poniżej opisano, jak użytkownicy portalu logują się w zintegrowanym portalu za pomocą danych logowania (wbudowany dostawca tożsamości) lub SAML (wersja beta).

Jeśli włączysz zarówno wbudowanego, jak i dostawcę tożsamości SAML, użytkownicy portalu będą mogli wybrać preferowaną metodę logowania.

Logowanie w portalu za pomocą danych logowania użytkownika (wbudowany dostawca tożsamości)

Gdy wbudowany dostawca tożsamości jest włączony, użytkownicy portalu mogą logować się w zintegrowanym portalu za pomocą swoich danych logowania (nazwy użytkownika i hasła), jak opisano w tych sekcjach:

Tworzenie konta użytkownika w zintegrowanym portalu

W przypadku wbudowanego dostawcy tożsamości użytkownicy portalu muszą utworzyć konto użytkownika w zintegrowanym portalu, zanim będą mogli korzystać z Twoich interfejsów API.

Użytkownicy portalu tworzą konto użytkownika w zintegrowanym portalu w ten sposób:

  1. Otwórz portal.

  2. Kliknij Zaloguj się.

    Wyświetli się strona logowania.

  3. Kliknij Utwórz konto.

    Wyświetli się strona Tworzenie konta.

    Okno tworzenia konta

  4. Wypełnij formularz.

    Musisz wpisać wartości we wszystkich wymaganych polach. Hasła muszą mieć co najmniej 8 znaków i zawierać co najmniej 1 cyfrę, 1 małą literę, 1 wielką literę i 1 znak specjalny.

  5. Przeczytaj i zaakceptuj warunki.

  6. Kliknij Utwórz konto.

  7. Wypełnij formularz CAPTCHA i kliknij Zweryfikuj (jeśli się pojawi).

    Konto użytkownika zostanie utworzone i wyślemy e-maila z potwierdzeniem.

  8. W ciągu 10 minut kliknij link w e-mailu z potwierdzeniem, aby dokończyć proces rejestracji.

    Jeśli nie klikniesz linku w ciągu 10 minut, musisz powtórzyć czynności opisane w tej procedurze, aby utworzyć konto i ponownie wyświetlić prośbę.

  9. Zaloguj się w zintegrowanym portalu (opisanym poniżej).

Logowanie się w zintegrowanym portalu

W przypadku wbudowanego dostawcy tożsamości użytkownicy portalu po zarejestrowaniu się w zintegrowanym portalu i zatwierdzeniu mogą logować się za pomocą swoich danych logowania (nazwy użytkownika i hasła).

Użytkownicy portalu logują się w ten sposób:

  1. Otwórz portal.
  2. Kliknij Zaloguj się. Wyświetli się strona logowania:Strona logowania
  3. Wpisz adres e-mail i hasło.
  4. Kliknij Zaloguj się.

Zmień hasło

W przypadku wbudowanego dostawcy tożsamości użytkownicy portalu zmieniają hasło w ten sposób:

  1. Otwórz portal.
  2. Kliknij Zaloguj się.
  3. Kliknij Zresetuj hasło.
  4. Wpisz adres e-mail konta, które chcesz zresetować.

  5. Kliknij Wyślij link do zresetowania hasła.

    Na ten adres e-mail zostanie wysłany link do resetowania hasła.

  6. Kliknij link w e-mailu z potwierdzeniem.

  7. Wpisz nowe hasło i potwierdź je.

    Hasła muszą mieć co najmniej 8 znaków i zawierać co najmniej 1 cyfrę, 1 małą literę, 1 wielką literę i 1 znak specjalny.

  8. Kliknij Utwórz nowe hasło.

Logowanie się w portalu przy użyciu uwierzytelniania SAML (wersja beta)

Gdy dostawca tożsamości SAML jest włączony, użytkownicy portalu logują się w zintegrowanym portalu za pomocą uwierzytelniania SAML w ten sposób:

  1. Otwórz portal.
  2. Kliknij Zaloguj się.

  3. Kliknij Zaloguj się przez SAML.

    Nastąpi przekierowanie do dostawcy SAML.

  4. Jeśli pojawi się prośba, wpisz dane logowania dostawcy tożsamości SAML.

Wyświetl dokumentację API

Użytkownicy portalu mogą wyświetlać opublikowaną w nim dokumentację interfejsu API w ten sposób:

  1. Otwórz portal.

  2. Na górnym pasku nawigacyjnym kliknij Interfejsy API. Wyświetli się strona Interfejsy API. Na przykład:

    Strona interfejsów API

  3. W razie potrzeby przefiltruj listę interfejsów API według kategorii, tytułu lub opisu, korzystając z narzędzi w panelu po lewej stronie.

  4. Kliknij kartę interfejsu API, aby wyświetlić dokumentację interfejsu API. Wyświetli się dokumentacja API.

Użytkownicy portalu mogą dowiedzieć się więcej o interfejsach API i je wypróbować lub pobrać dokument używany do renderowania dokumentacji API. Więcej informacji o tym, jak renderowana jest dokumentacja referencyjna interfejsu API, znajdziesz w artykule Publikowanie interfejsów API.

Wspólne ponoszenie odpowiedzialności za aplikację przy użyciu zespołów deweloperów (beta)

Zespoły deweloperów umożliwiają użytkownikom portalu wspólne ponoszenie odpowiedzialności za aplikację z innymi użytkownikami portalu. W sekcjach poniżej znajdziesz informacje o tym, jak tworzyć zespoły deweloperów i nimi zarządzać.

Informacje o rolach w zespole deweloperów

W tabeli poniżej znajdziesz podsumowanie ról, które można przypisać członkom zespołu deweloperów:

Rola Opis
Administrator aplikacji
  • Uprawnienia tylko do odczytu dla członków zespołu deweloperów i szczegółów zespołu deweloperów.
  • Uprawnienia do odczytu i zapisu w przypadku aplikacji.
Właściciel Pełne uprawnienia do odczytu i zapisu w przypadku członków zespołu deweloperów, szczegółów zespołu deweloperów i aplikacji.
Przeglądający Uprawnienia tylko do odczytu w przypadku członków zespołu programistów, szczegółów zespołu programistów i aplikacji.

Wyświetlanie strony Zespoły

Na stronie Zespoły wyświetlają się zespoły deweloperów, do których należysz.

Aby otworzyć stronę Zespoły:

  1. Zaloguj się w portalu.
  2. W menu konta użytkownika w portalu kliknij Zespoły.

Wyświetli się strona Zespoły, na której możesz:

Dodawanie zespołów deweloperów

Aby dodać zespół deweloperów:

  1. Zaloguj się w portalu.
  2. W menu konta użytkownika w portalu kliknij Zespoły.
  3. Kliknij + Nowy zespół.
  4. Wpisz jej nazwę i opis.

  5. Aby dodać osobę do zespołu deweloperów, kliknij + Dodaj kolejną osobę, wpisz adres e-mail użytkownika portalu i wybierz rolę w zespole deweloperów.

    Powtórz te czynności, aby dodać kolejnych członków.

  6. Aby usunąć członka zespołu programistów, kliknij Ikona usuwania obok jego nazwy.

  7. Kliknij Utwórz.

Edytowanie członkostwa w zespole deweloperów i ról

Aby edytować członkostwo w zespole deweloperów i role:

  1. Zaloguj się w portalu.
  2. W menu konta użytkownika w portalu kliknij Zespoły.
  3. Kliknij wiersz zespołu deweloperów, który chcesz edytować i którego jesteś właścicielem.

  4. Wykonaj co najmniej jedną z tych czynności:

    • Edytuj nazwę, opis i główną osobę kontaktową.
    • dodawać i usuwać członków zespołu deweloperów;
    • Aktualizowanie ról członków zespołu deweloperów.

  5. Kliknij Zapisz.

Usuwanie siebie z zespołu programistów

Aby usunąć siebie z zespołu deweloperów:

  1. Zaloguj się w portalu.
  2. W menu konta użytkownika w portalu kliknij Zespoły.
  3. Kliknij wiersz zespołu deweloperów, z którego chcesz się usunąć.
  4. Kliknij Opuść zespół.

Usuwanie zespołu deweloperów

Aby usunąć zespół deweloperów:

  1. Zaloguj się w portalu.
  2. W menu konta użytkownika w portalu kliknij Zespoły.
  3. Kliknij wiersz zespołu deweloperów, który chcesz usunąć.
  4. Kliknij Ikona usuwania.
  5. Aby potwierdzić usunięcie, kliknij Potwierdź.

Rejestrowanie aplikacji

Zarejestruj aplikacje dewelopera i aplikacje zespołu deweloperów zgodnie z opisem w kolejnych sekcjach.

Rejestrowanie aplikacji dewelopera

Użytkownicy portalu mogą rejestrować aplikacje, aby korzystać z opublikowanych przez Ciebie interfejsów API w ten sposób:

  1. W menu konta użytkownika kliknij Aplikacje.
  2. Aby utworzyć nową aplikację, kliknij + Nowa aplikacja.
  3. Wpisz nazwę i opis aplikacji w oknie Nowa aplikacja.

  4. Z menu Właściciel wybierz właściciela aplikacji.

    Domyślnie jesteś właścicielem aplikacji. Jeśli chcesz, możesz wybrać zespół deweloperów z menu, aby udostępnić odpowiedzialność za aplikację innym członkom zespołu. Zobacz Wspólne ponoszenie odpowiedzialności za aplikację za pomocą zespołów deweloperów (beta).

  5. W sekcji Katalog interfejsów API wybierz co najmniej 1 interfejs API.

    Interfejsy API w katalogu są podzielone na kategorie: interfejsy API wymagające uwierzytelnienia, które wymagają adresu URL wywołania zwrotnego, oraz interfejsy API publiczne. Aby utworzyć aplikację, musisz wybrać co najmniej 1 interfejs API.

  6. Jeśli w sekcji Uwierzytelnione interfejsy API wybierzesz interfejs API, wpisz adres URL wywołania zwrotnego.

    Więcej informacji znajdziesz w artykule Adresy URL wywołania zwrotnego.

  7. Kliknij Utwórz.

Rejestrowanie aplikacji zespołu deweloperów

Członkowie zespołu deweloperów mogą rejestrować aplikacje, aby zespół mógł korzystać z opublikowanych przez Ciebie interfejsów API, jak opisano poniżej.

Aby dowiedzieć się więcej o tym, jak:

Aby zarejestrować aplikacje zespołu deweloperów:

  1. W menu konta użytkownika kliknij Zespoły.
  2. Kliknij wiersz zespołu deweloperów, w którym chcesz zarejestrować aplikację.
  3. Aby utworzyć nową aplikację, kliknij + Nowa aplikacja.
  4. Wpisz nazwę i opis aplikacji w oknie Nowa aplikacja.

  5. Z menu Właściciel wybierz właściciela aplikacji.

    Domyślnie właścicielem aplikacji jest zespół deweloperów. Jeśli chcesz, możesz wybrać inny zespół deweloperów lub siebie jako właściciela w menu.

  6. W sekcji Katalog interfejsów API wybierz co najmniej 1 interfejs API.

    Interfejsy API w katalogu są podzielone na kategorie: interfejsy API wymagające uwierzytelnienia, które wymagają adresu URL wywołania zwrotnego, oraz interfejsy API publiczne. Aby utworzyć aplikację, musisz wybrać co najmniej 1 interfejs API.

  7. Jeśli w sekcji Uwierzytelnione interfejsy API wybierzesz interfejs API, wpisz adres URL wywołania zwrotnego.

    Więcej informacji znajdziesz w artykule Adresy URL wywołania zwrotnego.

  8. Kliknij Utwórz.

Zarządzanie interfejsami API w aplikacji

Jako producent interfejsu API publikujesz interfejsy API, aby umożliwić użytkownikom portalu korzystanie z usług API.

Użytkownicy portalu zarządzają tym, z których interfejsów API korzystają ich aplikacje. Interfejsy API zostaną dodane na stronie z informacjami o aplikacji. W przypadku niektórych interfejsów API zatwierdzenie nie jest automatyczne. Stan Oczekuje na zatwierdzenie oznacza interfejs API, do którego wysłano prośbę o dostęp, ale nie został on jeszcze przyznany.

Użytkownicy portalu mogą zarządzać interfejsami API w aplikacji z poziomu portalu w ten sposób:

  1. W menu konta użytkownika kliknij Aplikacje.
  2. Kliknij aplikację na liście.
  3. W sekcji Interfejsy API kliknij ikona włączania, lub Ikona wyłączania, aby odpowiednio włączyć lub wyłączyć dostęp do interfejsu API z aplikacji.
  4. W przypadku uwierzytelnionego interfejsu API dodaj lub zmień adres URL wywołania zwrotnego, jeśli jest to wymagane.

Wyświetlanie klucza interfejsu API i klucza tajnego aplikacji

Użytkownicy portalu mogą zarządzać kluczem interfejsu API aplikacji w portalu w ten sposób:

  1. W menu konta użytkownika kliknij Aplikacje.
  2. Kliknij aplikację na liście.
  3. Klucze interfejsu API znajdziesz w sekcji Klucze interfejsu API.
  4. Sprawdź, czy stan klucza interfejsu API to Aktywny. Jeśli Twój klucz interfejsu API wymaga zatwierdzenia i nie został jeszcze zatwierdzony, jego stan będzie oznaczony jako Oczekuje na zatwierdzenie.
  5. Aby wyświetlić tajny klucz, kliknij Pokaż tajny klucz.
  6. Najedź kursorem na klucz interfejsu API lub tajny klucz i kliknij ikona usuwania, aby skopiować go do schowka.

Wykonaj rotację klucza interfejsu API aplikacji

Użytkownik portalu może okresowo obracać klucz interfejsu API aplikacji lub w odpowiedzi na potencjalny wyciek lub naruszenie bezpieczeństwa. Gdy użytkownik portalu obraca klucz interfejsu API, tworzony jest nowy klucz z tymi samymi uprawnieniami do interfejsu API co oryginalny klucz. Oryginalny klucz API pozostaje aktywny, dopóki nie przestaniesz go używać. Musisz unieważnić stary klucz interfejsu API, aby zapobiec akceptowaniu jego danych logowania, zgodnie z opisem w sekcji Unieważnianie klucza interfejsu API aplikacji.

Użytkownicy portalu mogą obracać klucz interfejsu API aplikacji w portalu w ten sposób:

  1. W menu konta użytkownika kliknij Aplikacje.
  2. Kliknij aplikację na liście.
  3. W sekcji Klucze interfejsu API kliknij Dodaj klucz.
  4. Aby potwierdzić operację, w oknie kliknij Potwierdź.
  5. Opcjonalnie możesz cofnąć stary klucz interfejsu API, jak opisano poniżej.

Cofanie klucza interfejsu API aplikacji

Gdy użytkownik portalu obraca klucz interfejsu API, jak opisano w poprzedniej sekcji, klucz interfejsu API pozostaje aktywny, dopóki nie zostanie wycofany z użycia. Aby zapobiec akceptowaniu danych logowania klucza interfejsu API, musisz go unieważnić.

Użytkownicy portalu mogą unieważnić klucz interfejsu API aplikacji w Twoim portalu w ten sposób:

  1. W menu konta użytkownika kliknij Aplikacje.
  2. Kliknij nazwę aplikacji.
  3. W sekcji Klucze interfejsu API kliknij ikona wycofania, w kolumnie Działania obok klucza interfejsu API, który chcesz cofnąć.

  4. Aby potwierdzić operację, kliknij Potwierdź.

    Stan klucza zmieni się na Anulowany.

Edytowanie szczegółów aplikacji

Użytkownicy portalu mogą edytować szczegóły aplikacji w ten sposób:

  1. W menu konta użytkownika kliknij Aplikacje.
  2. Kliknij aplikację na liście.
  3. Na karcie Szczegóły aplikacji edytuj pola Nazwa lub Opis.
  4. W razie potrzeby zarządzaj interfejsami API w aplikacji.
  5. Kliknij Zapisz.

Usuń aplikację

Użytkownicy portalu mogą usunąć aplikację z portalu w ten sposób:

  1. W menu konta użytkownika kliknij Aplikacje.
  2. Kliknij aplikację na liście.
  3. Kliknij USUŃ.
  4. Aby potwierdzić operację, kliknij Potwierdź.

Aplikacja zostanie usunięta z listy Aplikacje.