Interakcja użytkowników z portalem

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

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

W poniższych sekcjach opisano, jak użytkownicy portalu mogą z niego korzystać.

Zaloguj się w portalu

W poniższych sekcjach opisano, jak użytkownicy portalu logują się w zintegrowanym portalu przy użyciu danych logowania użytkownika (wbudowanego dostawcy tożsamości) lub przy użyciu SAML (beta).

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

Zaloguj się 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 przy użyciu swoich danych logowania (nazwy użytkownika i hasła) zgodnie z opisem w tych sekcjach:

Tworzenie konta użytkownika w zintegrowanym portalu

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

Użytkownicy portalu mogą utworzyć konto użytkownika w zintegrowanym portalu w następujący sposób:

  1. Przejdź do portalu.

  2. Kliknij przycisk Zaloguj się.

    Pojawi się strona logowania.

  3. Kliknij Utwórz konto.

    Pojawi się strona Utwórz konto.

    Okno tworzenia konta

  4. Wypełnij formularz.

    Musisz wpisać wartości we wszystkich wymaganych polach. Hasła muszą się składać z co najmniej 8 znaków i zawierać przynajmniej po jednym z tych elementów: cyfrę, małą literę, wielką literę i znak specjalny.

  5. Przeczytaj i zaakceptuj warunki.

  6. Kliknij Utwórz konto.

  7. Wypełnij formularz CAPTCHA i kliknij Zweryfikuj (jeśli jest widoczny).

    Konto użytkownika zostanie utworzone i zostanie wysłany e-mail z potwierdzeniem.

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

    Jeśli nie klikniesz linku w ciągu 10 minut, musisz powtórzyć kroki opisane w tej procedurze, aby utworzyć konto i ponownie poprosić o pomoc.

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

Zaloguj się w zintegrowanym portalu

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

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

  1. Przejdź do portalu.
  2. Kliknij przycisk Zaloguj się. Na stronie logowania wyświetlają się te informacje: Strona logowania
  3. Wpisz adres e-mail i hasło.
  4. Kliknij przycisk Zaloguj się.

zmienić hasło,

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

  1. Przejdź do portalu.
  2. Kliknij przycisk Zaloguj się.
  3. Kliknij Zresetuj hasło.
  4. Wpisz adres e-mail konta, które chcesz zresetować.

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

    Na adres e-mail zostanie wysłany link umożliwiający zresetowanie hasła.

  6. Kliknij link w e-mailu z potwierdzeniem.

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

    Hasła muszą się składać z co najmniej 8 znaków i zawierać przynajmniej po jednym z tych elementów: cyfrę, małą literę, wielką literę i znak specjalny.

  8. Kliknij Utwórz nowe hasło.

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

Gdy dostawca tożsamości SAML jest włączony, użytkownicy portalu logują się w zintegrowanym portalu przy użyciu uwierzytelniania SAML w następujący sposób:

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

  3. Kliknij login with SAML (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ą przeglądać dokumentację interfejsu API opublikowaną w portalu:

  1. Przejdź do portalu.

  2. Kliknij Interfejsy API na górnym pasku nawigacyjnym. Zostanie wyświetlona strona interfejsów API. Przykład:

    Strona interfejsów API

  3. Korzystając z narzędzi w panelu po lewej stronie, możesz przefiltrować listę interfejsów API według kategorii, tytułu lub opisu.

  4. Kliknij kartę interfejsu API, aby wyświetlić dokumentację. Zostanie wyświetlona dokumentacja referencyjna interfejsu API.

Użytkownicy portalu mogą zapoznać się z interfejsami API i je wypróbować lub pobrać dokument służący do renderowania dokumentacji referencyjnej API. Więcej informacji o sposobie renderowania dokumentacji referencyjnej API znajdziesz w artykule Publikowanie interfejsów API.

Współdzielenie odpowiedzialności za aplikację przez zespoły programistów (beta)

Zespoły programistów umożliwiają użytkownikom portalu współdzielenie odpowiedzialności za aplikację z innymi użytkownikami portalu. W sekcjach poniżej dowiesz się, jak tworzyć zespoły programistó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 programistów:

Rola Opis
Administrator aplikacji
  • Uprawnienia tylko do odczytu dotyczące członków zespołu programistów i informacji o zespole deweloperów.
  • Uprawnienia do odczytu i zapisu w przypadku aplikacji.
Właściciel Pełne uprawnienia do odczytu i zapisu dotyczące członków zespołu programistów, informacji o zespole deweloperów oraz aplikacji.
Wyświetlający Uprawnienia tylko do odczytu dotyczące członków zespołu deweloperów, informacji o zespole deweloperów oraz aplikacji.

Wyświetl stronę Zespoły

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

Aby uzyskać dostęp do strony Zespoły:

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

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

Dodaj zespoły programistów

Aby dodać zespół programistów:

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

  5. Aby dodać członka zespołu programistów, kliknij + Dodaj kolejnego członka, wpisz adres e-mail użytkownika portalu i wybierz rolę w zespole dewelopera.

    Powtórz te czynności, aby dodać kolejnych użytkowników.

  6. Aby usunąć członka z zespołu programistów, kliknij ikona usuwania obok członka zespołu, którego chcesz usunąć.

  7. Kliknij Utwórz.

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

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

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

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

    • Edytuj imię i nazwisko, opis i główną osobę kontaktową.
    • Dodaj lub usuń członków zespołu programistów.
    • Zaktualizuj role członków zespołu programistów.

  5. Kliknij Zapisz.

Usuwanie siebie z zespołu programistów

Aby usunąć siebie z zespołu dewelopera:

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

Usuwanie zespołu programistów

Aby usunąć zespół programistów:

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

Zarejestruj aplikacje

Zarejestruj aplikacje deweloperów i aplikacje zespołu deweloperów zgodnie z opisem w sekcjach poniżej.

Rejestrowanie aplikacji deweloperów

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

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

  4. Na liście Właściciel wybierz właściciela aplikacji.

    Domyślnie jesteś właścicielem aplikacji. W razie potrzeby wybierz z menu zespół programistów, aby podzielić się odpowiedzialność za aplikację innym członkom tego zespołu. Zobacz artykuł Współdzielenie odpowiedzialności za aplikację z zespołami deweloperów (beta).

  5. W sekcji API Catalog wybierz co najmniej 1 interfejs API.

    Interfejsy API w katalogu są klasyfikowane jako uwierzytelnione interfejsy API, które wymagają adresu URL wywołania zwrotnego, lub publiczne interfejsy API. 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 Informacje o adresach URL wywołań zwrotnych.

  7. Kliknij Utwórz.

Rejestrowanie aplikacji zespołu programistów

Członkowie zespołu programistów mogą rejestrować aplikacje, by umożliwić im korzystanie z opublikowanych przez Ciebie interfejsów API w sposób opisany poniżej.

Aby dowiedzieć się więcej:

Aby zarejestrować aplikacje zespołu deweloperów:

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

  5. Na liście Właściciel wybierz właściciela aplikacji.

    Domyślnie właścicielem aplikacji jest zespół programistów. W razie potrzeby wybierz w menu inny zespół programistów lub siebie jako właściciela.

  6. W sekcji API Catalog wybierz co najmniej 1 interfejs API.

    Interfejsy API w katalogu są klasyfikowane jako uwierzytelnione interfejsy API, które wymagają adresu URL wywołania zwrotnego, lub publiczne interfejsy API. 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 Informacje o adresach URL wywołań zwrotnych.

  8. Kliknij Utwórz.

Zarządzanie interfejsami API w aplikacji

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

Użytkownicy portalu decydują, których interfejsów API używają 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 wskazuje interfejs API, dla którego poproszono o dostęp, ale jeszcze go nie przyznano.

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

  1. W menu konta użytkownika wybierz 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 zgodnie z wymaganiami.

Wyświetlanie klucza i tajnego klucza interfejsu API aplikacji

Użytkownicy portalu mogą zarządzać kluczem interfejsu API aplikacji z poziomu portalu:

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

Rotacja klucza interfejsu API dla aplikacji

Użytkownik portalu może okresowo wykonywać rotację klucza interfejsu API aplikacji lub w odpowiedzi na potencjalny wyciek lub naruszenie zabezpieczeń. Gdy użytkownik portalu dokona rotacji klucza interfejsu API, zostanie utworzony nowy klucz interfejsu API z tymi samymi uprawnieniami interfejsu API co pierwotny klucz. Pierwotny klucz interfejsu API pozostaje aktywny, gdy nie jest on używany. Aby dane logowania nie zostały zaakceptowane, musisz unieważnić stary klucz interfejsu API zgodnie z opisem w sekcji Unieważnianie klucza interfejsu API dla aplikacji.

Użytkownicy portalu mogą wykonać rotację klucza interfejsu API aplikacji z portalu w następujący sposób:

  1. W menu konta użytkownika wybierz Aplikacje.
  2. Kliknij aplikację na liście.
  3. W sekcji API Keys (Klucze interfejsu API) kliknij Add Key (Dodaj klucz).
  4. W oknie dialogowym kliknij Potwierdź, aby potwierdzić operację.
  5. Opcjonalnie unieważnij stary klucz interfejsu API w sposób opisany poniżej.

Unieważnianie klucza interfejsu API dla aplikacji

Gdy użytkownik portalu wykona rotację klucza interfejsu API zgodnie z opisem w poprzedniej sekcji, klucz interfejsu API pozostanie aktywny w czasie, gdy nie będzie już używany. Aby dane logowania nie zostały zaakceptowane, musisz unieważnić klucz interfejsu API.

Użytkownicy portalu mogą anulować klucz interfejsu API aplikacji w portalu:

  1. W menu konta użytkownika wybierz Aplikacje.
  2. Kliknij nazwę aplikacji.
  3. W sekcji API Keys (Klucze interfejsu API) kliknij ikona unieważnienia w kolumnie Actions (Działania) powiązanym z kluczem interfejsu API, który chcesz unieważnić.

  4. Kliknij Potwierdź, aby potwierdzić operację.

    Stan klucza zostanie zmieniony na Unieważniony.

Edytuj szczegóły aplikacji

Użytkownicy portalu mogą edytować szczegóły aplikacji w następujący sposób:

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

Usuń aplikację

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

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

Aplikacja zostanie usunięta z listy aplikacji.