Konfigurowanie rejestracji aplikacji

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

Deweloperzy rejestrują aplikacje na stronie Moje aplikacje w portalu Usługi dla deweloperów. Deweloperzy uzyskują dostęp do strony Moje aplikacje z poziomu menu głównego portalu:

Aby zarejestrować nową aplikację, deweloper klika przycisk Dodaj nową aplikację na stronie Moje aplikacje.

Na portalu wyświetli się formularz rejestracji domyślnej aplikacji:

Domyślnie deweloper musi tylko podać nazwę aplikacji, adres URL wywołania zwrotnego i listę produktów API, które chce dodać do aplikacji.

Jako dostawca interfejsu API masz pełną kontrolę nad procesem rejestracji aplikacji. Możesz na przykład skonfigurować:

• lista usług interfejsu API dostępnych na portalu;
• Czy istnieje domyślna usługa API
• czy adres URL wywołania zwrotnego jest wymagany;
• Czy klucz interfejsu API został zatwierdzony ręcznie czy automatycznie w przypadku usługi interfejsu API
• czy do zarejestrowania aplikacji wymagane są inne informacje na stronie Dodawanie aplikacji.

Z tego tematu dowiesz się, jak skonfigurować proces rejestracji aplikacji w portalu. Nie wyjaśnia on jednak, jak tworzyć produkty API. Więcej informacji:

• Tworzenie usług API
• Używanie interfejsu Edge Management API do publikowania interfejsów API

Możesz skonfigurować portal tak, aby deweloperzy nie mogli tworzyć, usuwać ani edytować aplikacji na podstawie przypisanej im roli. Możesz na przykład skonfigurować portal tak, aby tworzyć jedną domyślną aplikację dla wszystkich deweloperów, gdy się rejestrują. Następnie zezwalasz tylko niektórym deweloperom na dodawanie nowych aplikacji, prawdopodobnie na podstawie struktury opłat lub innych cech dewelopera. Za pomocą ról i uprawnień możesz kontrolować, którzy deweloperzy mogą tworzyć, usuwać i edytować aplikacje. Więcej informacji znajdziesz w artykule Dodawanie kont użytkowników i zarządzanie nimi.

Określanie usług interfejsu API dostępnych na portalu

Istnieją 2 sposoby określania usług interfejsu API, które są dostępne, gdy deweloper uzyskuje dostęp do portalu:

• Określanie poziomu dostępu podczas tworzenia produktu interfejsu API
• Ograniczanie dostępu do usługi API na podstawie ról

Określanie poziomu dostępu podczas tworzenia usługi interfejsu API

Podczas tworzenia produktu interfejsu API określasz opcję poziomu dostępu do tego produktu, jak pokazano poniżej:

Więcej informacji o tym, jak poziom dostępu wpływa na dostępność produktu interfejsu API na portalu dla deweloperów Drupala 7, znajdziesz w artykule Poziom dostępu.

Ograniczanie dostępu do usługi interfejsu API na podstawie ról

Po włączeniu modułu Drupala „Dostęp do roli w usłudze interfejsu API” możesz określić role, które mogą uzyskiwać dostęp do poszczególnych usług interfejsu API.

Aby ograniczyć dostęp do usługi interfejsu API na podstawie ról dewelopera:

1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub tworzenia treści.
2. Sprawdź role w portalu deweloperskim i przypisania użytkowników:
   • W menu administracyjnym Drupala wybierz Osoby > Uprawnienia > Role i w razie potrzeby dodaj lub zmodyfikuj role i uprawnienia dewelopera.
   • W menu administracyjnym Drupala wybierz Osoby i w razie potrzeby zmień przypisania użytkowników i ról.
3. W menu administracyjnym Drupala wybierz Konfiguracja > Portal deweloperski > Dostęp do roli produktu API.
4. Wybierz role, które mają mieć dostęp do poszczególnych usług API.
5. Kliknij Zapisz konfigurację.

Konfigurowanie sposobu kojarzenia przez dewelopera produktów API z aplikacją

Aby zarejestrować nową aplikację, deweloper wybiera przycisk Dodaj nową aplikację na stronie Moje aplikacje, aby otworzyć formularz Dodawanie aplikacji:

W zależności od konfiguracji portalu deweloper może wybrać co najmniej 1 interfejs API do powiązania z aplikacją w momencie jej rejestracji. Możesz też określić produkt domyślny przypisany do wszystkich aplikacji.

Aby kontrolować wybór interfejsów API podczas rejestrowania aplikacji, w portalu dostępne są te opcje konfiguracji:

• Nie twórz powiązań między aplikacjami a żadną usługą API.
• Połącz wszystkie aplikacje z co najmniej 1 domyślnym interfejsem API (skonfigurowanym poniżej). Deweloperzy nie mogą dodawać do aplikacji żadnych innych usług interfejsu API.
• zezwolić na wybór pojedynczego produktu API, ale nie wymagać tego;
• Wymagaj wyboru pojedynczego produktu interfejsu API.
• Zezwalaj na wybór wielu produktów API, ale nie wymagaj żadnego z nich.
• Zezwalaj na wybór wielu produktów API i wymagaj wybrania co najmniej jednego.

Możesz też kontrolować element HTML, który wyświetla się w formularzu używanym przez dewelopera do wyboru produktu interfejsu API. Dostępne opcje:

• listy rozwijane,
• pola wyboru lub przyciski opcji. Jeśli deweloper może wybrać kilka interfejsów API, wyświetlają się pola wyboru, a jeśli tylko jeden, to opcje.

Aby ustawić opcję wyboru produktów w interfejsie API:

1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub tworzenia treści.
2. W menu administracyjnym Drupala kliknij Konfiguracja > Ustawienia portalu programistycznego > Ustawienia aplikacji.
3. Na stronie Ustawienia aplikacji rozwiń obszar Ustawienia usługi w interfejsie API.
4. W sekcji Zarządzanie interfejsami API wybierz opcję, która kontroluje wybór interfejsów API.
5. Jeśli wybierzesz opcję „Połącz wszystkie aplikacje z co najmniej 1 domyślnym produktem w interfejsie API (skonfigurowanym poniżej)”, w sekcji Domyślny produkt w interfejsie API ustaw domyślny produkt.
6. W sekcji Widgety produktów API wybierz element HTML używany przez programistów do wybierania produktów API.
7. Zapisz konfigurację.

Konfigurowanie obsługi adresu URL wywołania zwrotnego

Jeśli serwer pośredniczący interfejsu API w Twoim produkcie interfejsu API korzysta z „trójstopniowego uwierzytelniania OAuth” (typu udzielania uprawnień za pomocą kodu autoryzacji), podczas rejestrowania aplikacji deweloperzy muszą podać adres URL wywołania zwrotnego. Adres URL wywołania zwrotnego zwykle określa adres URL aplikacji, która ma otrzymywać kod autoryzacji w imieniu aplikacji klienta. Dodatkowo ten ciąg adresu URL jest używany do weryfikacji. Klient musi wysłać ten adres URL do Apigee Edge, gdy żąda kodów autoryzacji i tokenów dostępu, a parametr redirect_uri musi być zgodny z zarejestrowanym. Więcej informacji znajdziesz w artykule Implementowanie typu uwierzytelniania za pomocą kodu autoryzacji.

Aby kontrolować adres URL wywołania zwrotnego w przypadku wyboru produktu w interfejsie API:

1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub uprawnieniami do tworzenia treści.
2. W menu administracyjnym Drupala kliknij Konfiguracja > Ustawienia portalu deweloperskiego > Aplikacja Atrybuty.
3. Na stronie Ustawienia aplikacji rozwiń obszar Ustawienia adresu URL wywołania zwrotnego.
4. W sekcji Obsługa adresu URL połączenia zwrotnego wybierz jedną z tych opcji.
   • Adres URL wywołania zwrotnego jest wymagany w przypadku wszystkich aplikacji dewelopera.
   • Adres URL wywołania zwrotnego jest opcjonalny w przypadku wszystkich aplikacji dewelopera.
   • Adres URL wywołania zwrotnego nie jest wymagany ani wyświetlany.
5. Zapisz konfigurację.

Wyświetlanie analityki dotyczącej korzystania z aplikacji

Portal może wyświetlać informacje analityczne o korzystaniu z aplikacji. Jeśli wyświetlanie danych analitycznych jest włączone, deweloperzy aplikacji mogą wyświetlać dane analityczne na stronie Moje aplikacje dla każdej aplikacji. Na przykład deweloper może wyświetlać te dane analityczne:

• Przepustowość
• Maksymalny czas odpowiedzi
• Minimalny czas odpowiedzi
• Liczba wiadomości
• Liczba błędów

Aby włączyć statystyki w portalu:

1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub tworzenia treści.
2. W menu administracyjnym Drupala kliknij Konfiguracja > Portal deweloperski > Ustawienia aplikacji.
3. Na stronie Ustawienia aplikacji rozwiń obszar Ustawienia wydajności aplikacji.
4. Zaznacz pole wyboru Pokaż kartę Analytics w aplikacji dla programistów.
5. W kolumnie Środowisko wybierz Testowa lub Produkcyjna, aby wysłać zapytanie o dane analityczne. W przypadku portalu dostępnego publicznie zazwyczaj wybierasz Produkcyjny.
6. Zapisz konfigurację.

Aby wyświetlić w portalu statystyki dotyczące aplikacji:

1. Wybierz nazwę aplikacji na stronie Moje aplikacje.
2. Wybierz link Analytics w przypadku aplikacji.
3. Wybierz typ wyświetlanych statystyk i zakres dat:
4. Wyświetlają się wybrane informacje:
   

Ręczne zatwierdzanie lub odwoływanie klucza interfejsu API w usłudze API

Gdy deweloper doda produkt interfejsu API do aplikacji i zarejestruje aplikację, portal zwróci deweloperowi klucz interfejsu API tej aplikacji. Następnie deweloper używa tego klucza, aby uzyskać dostęp do serwerów proxy interfejsu API dołączonych do produktu interfejsu API powiązanego z aplikacją.

Podczas tworzenia produktu interfejsu API możesz kontrolować proces zatwierdzania kluczy dla każdego produktu:

Proces zatwierdzania może być:

• Automatyczny – zatwierdzony klucz interfejsu API jest zwracany przez portal dla usługi interfejsu API, gdy deweloper rejestruje aplikację. Możesz później unieważnić automatycznie zatwierdzony klucz.
• Ręcznie – klucz interfejsu API jest zwracany przez portal, gdy deweloper rejestruje aplikację, ale klucz nie jest aktywowany w żadnych usługach interfejsu API, które korzystają z ręcznej weryfikacji klucza. Administrator musi ręcznie zatwierdzić klucz interfejsu API w interfejsie zarządzania Edge lub w interfejsie API, zanim deweloper będzie mógł go używać do uzyskiwania dostępu do interfejsu API. Możesz później cofnąć klucz zatwierdzony ręcznie.

Więcej informacji znajdziesz w artykule Tworzenie usług opartych na interfejsie API.

Jeśli Twój portal umożliwia deweloperowi dodawanie do aplikacji wielu produktów API, deweloper może dodać niektóre produkty z automatyczną akceptacją klucza, a niektóre z ręczną. Deweloperzy mogą od razu używać zwróconego klucza API we wszystkich automatycznie zatwierdzanych usługach interfejsu API, oczekując na ostateczne zatwierdzenie tych usług, które wymagają ręcznego zatwierdzenia.

Aby wyświetlić listę produktów interfejsu API dla aplikacji oraz stan zatwierdzenia klucza dla produktu interfejsu API, deweloper wybiera nazwę aplikacji na stronie Moje aplikacje, a następnie klika link Produkty:

W tym przykładzie usługa Premium Weather API korzysta z ręcznej weryfikacji i czeka na zatwierdzenie klucza przez administratora. Bezpłatna usługa interfejsu API korzysta z automatycznego zatwierdzenia i używa klucza dostępu, który został zatwierdzony.

Aby ręcznie zatwierdzić lub odwołać klucz:

1. Zaloguj się w interfejsie zarządzania Edge jako użytkownik z uprawnieniami administracyjnymi w organizacji.
2. W prawym górnym rogu w menu kliknij Platforma API.
3. Aby otworzyć listę aplikacji dewelopera, wybierz Opublikuj > Aplikacje dewelopera.
4. Kliknij przycisk Oczekujące, aby wyświetlić listę aplikacji z oczekującymi prośbami o klucze:
   

   

5. Wybierz nazwę aplikacji, którą chcesz zatwierdzić.
6. W prawym górnym rogu strony z informacjami o aplikacji kliknij przycisk Edytuj.
7. Na liście usług API dla aplikacji w sekcji Czynności:
   • Aby zatwierdzić klucz, kliknij przycisk Zatwierdź przy każdym produkcie interfejsu API, który wymaga ręcznego zatwierdzenia.
     

     

   • Aby cofnąć zatwierdzony klucz, kliknij przycisk Cofnij w sekcji Działania w przypadku produktu interfejsu API, aby cofnąć dostęp.
     

     

8. Zapisz aplikację. Klucz interfejsu API został zatwierdzony.

Zarządzanie buforowaniem aplikacji i usługi API

Informacje o produktach API i aplikacjach dewelopera są przechowywane zdalnie w portalu Apigee Edge. Oznacza to, że zmiany dotyczące aplikacji i produktów API można wprowadzać w interfejsie Edge lub za pomocą interfejsu API, bez korzystania z portalu. Jeśli na przykład administrator backendu doda nowy produkt interfejsu API, te informacje nie zostaną od razu zaktualizowane na portalu.

Aby mieć pewność, że portal jest zsynchronizowany z backendem Edge, możesz ręcznie wywołać aktualizację pamięci podręcznej portalu, zaktualizować pamięci podręczne automatycznie podczas wykonywania zadania cron portalu lub wykonać obie te czynności. Jeśli na przykład skonfigurujesz zadanie cron tak, aby było wykonywane często, np. co 5 lub 10 minut, możesz nie chcieć tak często aktualizować produktów interfejsu API i pamięci podręcznej aplikacji dewelopera. W takiej sytuacji możesz ręcznie wywołać aktualizację pamięci podręcznej. Jeśli jednak zadanie cron jest wykonywane co godzinę lub co 2 godziny, czas potrzebny na zaktualizowanie pamięci podręcznej może nie mieć większego znaczenia.

Domyślnie portal jest skonfigurowany tak, aby odtwarzać pamięć podręczną produktu API i aplikacji dla programistów za każdym razem, gdy uruchamia się cron.

Aby określić, czy za każdym razem, gdy cron jest uruchamiany, ma być odtwarzana pamięć podręczna produktu API i aplikacji dla programistów:

1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub tworzenia treści.
2. W menu Drupala kliknij Konfiguracja > Ustawienia portalu dla deweloperów > Ustawienia aplikacji.
3. Zaznacz lub odznacz pole Ponownie twórz pamięć podręczną usługi API i aplikacji dla deweloperów za każdym razem, gdy cron jest uruchamiany.
4. Zapisz ustawienia.

Aby ręcznie zaktualizować pamięć podręczną:

1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub tworzenia treści.
2. W menu Drupala kliknij ikonę strony głównej > Wyczyść wszystkie pamięci podręczne.

Dostosowywanie pól formularza służących do rejestrowania aplikacji

Gdy deweloper rejestruje aplikację, portal wyświetla formularz domyślny:

Jako dostawca interfejsu API możesz zmodyfikować ten formularz, aby zachęcić dewelopera do podania dodatkowych informacji, takich jak identyfikator klienta, docelowa platforma aplikacji lub inne informacje. W portalu możesz dodawać do tego formularza nowe pola. Te pola mogą być:

• Wymagana czy opcjonalna
• Wyświetlane przez różne elementy HTML, takie jak pola tekstowe, pola wyboru, pola wyboru i inne
• Może być ustawiony tak, aby pojawiał się w dowolnym miejscu formularza między polem Adres URL wywołania zwrotnego a polem Produkt.

Na przykład w tym formularzu jest wymagane pole Identyfikator klienta i opcjonalne pole Platforma docelowa:

Gdy dodasz nowe pola do formularza, ich wartości zostaną automatycznie przesłane do Edge wraz ze wszystkimi innymi polami, gdy deweloper prześle formularz. Oznacza to, że możesz wyświetlać te pola lub je modyfikować w Edge albo używać interfejsu Edge Management API, aby uzyskać dostęp do tych pól ze skryptu.

Aby wyświetlić nowe pola formularza w interfejsie zarządzania Edge, otwórz Publikowanie > Aplikacje dla programistów, a następnie wybierz nazwę aplikacji. Nowe wartości pól pojawią się w obszarze Atrybuty niestandardowe na stronie o nazwie odpowiadającej nazwie wewnętrznej pola:

Wartości pól są też wyświetlane w obszarze Szczegóły aplikacji na stronie Moje aplikacje dewelopera:

Deweloper może też edytować wartości, klikając link Edytuj na stronie Moje aplikacje.

W poniższych procedurach opisaliśmy, jak skonfigurować formularze tworzenia aplikacji za pomocą interfejsu administratora. Deweloperzy Drupala mogą wprowadzać dodatkowe zmiany, w tym modyfikować stronę „Moje aplikacje” za pomocą niestandardowych haków. Aby dowiedzieć się więcej o zmianach zachowań za pomocą kodu, zapoznaj się z przykładami interfejsu API aplikacji w pliku /profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php.

Aby dodać pole do formularza rejestracji aplikacji:

1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub uprawnieniami do tworzenia treści.
2. Upewnij się, że moduł Zarządzanie atrybutami aplikacji DevConnect jest włączony.
3. W menu administracyjnym Drupala wybierz Konfiguracja > Ustawienia portalu deweloperskiego > Atrybuty aplikacji portalu deweloperskiego.
4. U góry strony kliknij przycisk Dodaj atrybut aplikacji w portalu deweloperskim.
5. Skonfiguruj pole. Na przykład w przypadku pola Identyfikator klienta widocznego powyżej użyj tych ustawień:
   • Nazwa wewnętrzna = cust_id. To nazwa zmiennej używanej do przechowywania wartości pola.
   • Nazwa publiczna = identyfikator klienta
   • Opis = wpisz identyfikator klienta.
   • Zaznacz pole wyboru Wymagaj tego atrybutu.
   • Zaznacz pole wyboru Wyświetl ten atrybut.
   • Widget = pole tekstowe
   • Kliknij Zapisz, aby wrócić na stronę Atrybuty aplikacji w Portalu deweloperskim.
6. Kliknij Zapisz zmiany.
7. W menu Drupal kliknij ikonę domu > Wyczyść wszystkie pamięci podręczne.
   Aby nowe pole pojawiło się w formularzu, konieczne może być wyczyszczenie pamięci podręcznej przeglądarki.

Aby dodać opcjonalne pole, w którym deweloper może określić platformę aplikacji, ustaw atrybuty pola w ten sposób:

• Nazwa wewnętrzna = intended_platforms
• Public Name = Platforms
• Opis = określ co najmniej 1 platformę dla aplikacji.
• Wyczyść pola wyboru Wymagaj tego atrybutu.
• Zaznacz pole wyboru Wyświetl ten atrybut.
• Widżet = lista pól wyboru
• Kliknij Zapisz, aby wrócić na stronę Atrybuty aplikacji w Portalu deweloperskim.

Aby zmienić kolejność atrybutów w formularzu:

1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub uprawnieniami do tworzenia treści.
2. W menu administracyjnym Drupala wybierz Konfiguracja > Ustawienia portalu deweloperskiego > Atrybuty aplikacji portalu deweloperskiego.
3. Kliknij znak plusa + w kolumnie Nazwa i przeciągnij właściwość w miejsce, w którym chcesz ją wyświetlić w formularzu.
4. Zapisz zmiany.