Konfigurowanie rejestracji aplikacji

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

Deweloperzy mogą rejestrować aplikacje, korzystając ze strony Moje aplikacje w portalu usług dla programistów. Aby uzyskać dostęp do strony Moje aplikacje z menu głównego portalu:

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

W portalu wyświetli się domyślny formularz rejestracji aplikacji:

Domyślnie deweloper musi określić tylko nazwę aplikacji, adres URL wywołania zwrotnego i listę usług 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 API dostępnych w portalu
• Określa, czy istnieje domyślna usługa API.
• Określa, czy adres URL wywołania zwrotnego jest wymagany
• Określa, czy klucz interfejsu API jest zatwierdzony ręcznie czy automatycznie dla usługi interfejsu API.
• czy na stronie Dodaj aplikację są wymagane jakiekolwiek inne informacje do zarejestrowania aplikacji.

Z tego artykułu dowiesz się, jak skonfigurować proces rejestracji aplikacji w portalu. W tym temacie nie ma jednak opisu tworzenia usług API. Więcej informacji:

• Tworzenie usług API
• Korzystanie z interfejsu Edge Management API do publikowania interfejsów API

Możesz skonfigurować portal tak, aby uniemożliwić deweloperom tworzenie, usuwanie i edytowanie aplikacji na podstawie roli przypisanej do dewelopera. Możesz na przykład skonfigurować portal w taki sposób, aby po zarejestrowaniu dewelopera utworzyć jedną domyślną aplikację dla wszystkich deweloperów. Następnie zezwalasz tylko niektórym deweloperom na dodawanie nowych aplikacji zależnie od struktury opłat lub innych cech dewelopera. Używaj ról i uprawnień, aby decydować, którzy deweloperzy mogą tworzyć, usuwać i edytować aplikacje. Więcej informacji znajdziesz w artykule o dodawaniu kont użytkowników i zarządzaniu nimi.

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

Usługi API, które są dostępne, gdy deweloper uzyskuje dostęp do portalu, możesz określić na 2 sposoby:

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

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

Podczas tworzenia usługi API określasz opcję poziomu dostępu, jak pokazano poniżej:

Więcej informacji o tym, jak poziom dostępu wpływa na dostępność usługi API w portalu dla deweloperów Drupal 7, znajdziesz w sekcji Poziom dostępu.

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

Włączając moduł Drupal dostępu do roli interfejsu API, możesz określić role, które mają mieć dostęp do poszczególnych usług API.

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

1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub z uprawnieniami do tworzenia treści.
2. Sprawdź role i przypisania użytkowników w portalu dla programistów:
   • W menu administrowania Drupal wybierz Osoby > Uprawnienia > Role i w razie potrzeby dodaj lub edytuj role oraz uprawnienia dewelopera.
   • W menu administrowania Drupal wybierz Osoby i w razie potrzeby edytuj przypisania użytkowników i ról.
3. W menu administrowania Drupal wybierz Konfiguracja > Portal dla programistów > Dostęp do roli usługi API.
4. Wybierz role, które mają mieć dostęp do poszczególnych usług interfejsu API.
5. Kliknij Save setup (Zapisz konfigurację).

Konfigurowanie sposobu powiązania przez dewelopera usług interfejsu API z aplikacją

Aby zarejestrować nową aplikację, deweloper klika przycisk Dodaj nową aplikację na stronie Moje aplikacje, co otwiera formularz dodawania aplikacji:

W zależności od tego, jak skonfigurujesz portal, deweloper może wybrać co najmniej 1 usługę API, którą będzie można powiązać z aplikacją w momencie jej rejestracji. Możesz też określić usługę domyślną przypisaną do wszystkich aplikacji.

W portalu dostępne są te opcje konfiguracji, które pozwalają kontrolować wybór usług interfejsu API podczas rejestrowania aplikacji:

• Nie należy wiązać aplikacji z żadną usługą API.
• Powiąż wszystkie aplikacje z co najmniej jedną domyślną usługą API (skonfigurowaną poniżej). Deweloperzy nie mogą dodawać do aplikacji żadnych innych usług interfejsu API.
• Zezwalaj na wybór jednej usługi API, ale nie wymagaj tego.
• Wymagaj wyboru jednej usługi interfejsu API.
• Zezwalaj na wybór wielu usług API, ale nie wymagaj żadnych.
• Zezwalaj na wybór wielu usług API i wymagaj co najmniej jednej.

Możesz też kontrolować element HTML wyświetlany w formularzu, którego deweloper użyje do wyboru usługi API. Dostępne opcje:

• Listy.
• Pola wyboru lub przyciski. Pola wyboru pojawiają się, gdy deweloper może wybrać wiele usług API, a przyciski pojawiają się, gdy może on wybrać tylko jedną usługę API.

Aby ustawić opcję wyboru usługi w interfejsie API:

1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub z uprawnieniami do tworzenia treści.
2. W menu administrowania Drupal wybierz Configuration > Dev Portal Settings > Application Settings (Konfiguracja > Ustawienia portalu dla programistów > Ustawienia aplikacji).
3. Na stronie Ustawienia aplikacji rozwiń obszar Ustawienia usług interfejsu API.
4. W sekcji Obsługa usług interfejsu API wybierz opcję, która kontroluje wybór usług interfejsu API.
5. Jeśli wybierzesz opcję „Powiąż wszystkie aplikacje z co najmniej jedną domyślną usługą API (skonfigurowaną poniżej)”, ustaw usługę domyślną w sekcji Domyślna usługa API.
6. W sekcji Widżet interfejsu API wybierz element HTML używany przez programistów do wybierania usług interfejsu API.
7. Zapisz konfigurację.

Konfigurowanie obsługi adresu URL wywołania zwrotnego

Jeśli serwer proxy interfejsu API w Twojej usłudze API używa „trzyetapowej autoryzacji OAuth” (typu uwierzytelnienia kodu autoryzacji), deweloperzy muszą podać URL wywołania zwrotnego podczas rejestrowania aplikacji. Adres URL wywołania zwrotnego zwykle określa adres URL aplikacji wyznaczonej do otrzymywania kodu autoryzacji w imieniu aplikacji klienckiej. Dodatkowo ten ciąg URL służy do weryfikacji. Klient musi wysłać ten URL do Apigee Edge podczas żądania kodów autoryzacji i tokenów dostępu, a parametr redirect_uri musi być zgodny z zarejestrowanym. Więcej informacji znajdziesz w artykule o implementowaniu typu przyznania kodu autoryzacji.

Aby określić adres URL wywołania zwrotnego dla wyboru usługi przy użyciu interfejsu API:

1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub z uprawnieniami do tworzenia treści.
2. W menu administrowania Drupal wybierz Configuration > Dev Portal Settings > Application Attributes (Konfiguracja > Ustawienia portalu dla programistów > Atrybuty aplikacji).
3. Na stronie Ustawienia aplikacji rozwiń obszar Ustawienia URL-a wywołania zwrotnego.
4. W sekcji Obsługa adresów URL wywołania zwrotnego wybierz jedną z poniższych opcji.
   • URL wywołania zwrotnego jest wymagany w przypadku wszystkich aplikacji dewelopera.
   • 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 statystyk użytkowania aplikacji

Portal może wyświetlać dane analityczne na temat wykorzystania aplikacji. Jeśli wyświetlanie statystyk jest włączone, deweloperzy mogą zobaczyć statystyki każdej aplikacji na stronie Moje aplikacje. Deweloper może na przykład wyświetlać te statystyki dotyczące aplikacji:

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

Aby włączyć analitykę w portalu:

1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub z uprawnieniami do tworzenia treści.
2. W menu administrowania Drupal wybierz Configuration > Dev Portal > Application Settings (Konfiguracja > Portal dla programistów > Ustawienia aplikacji).
3. Na stronie Ustawienia aplikacji rozwiń obszar Ustawienia wydajności aplikacji.
4. Zaznacz pole wyboru Pokaż kartę Statystyki aplikacji dewelopera.
5. Wybierz Testowe lub Produkcyjne jako Środowisko, aby wysyłać zapytania o dane analityczne. W przypadku portalu dostępnego publicznie zazwyczaj należy wybrać Produkcyjna.
6. Zapisz konfigurację.

Aby wyświetlać w portalu statystyki aplikacji:

1. Wybierz nazwę aplikacji na stronie Moje aplikacje.
2. Kliknij link Analytics obok aplikacji.
3. Wybierz rodzaj statystyk do wyświetlenia i zakres dat:
4. Pojawią się wybrane informacje:
   

Ręczne zatwierdzanie lub unieważnianie klucza interfejsu API dla usługi API

Gdy deweloper doda usługę API do aplikacji, a następnie ją zarejestruje, portal zwraca deweloperowi klucz interfejsu API tej aplikacji. Następnie za pomocą tego klucza interfejsu API uzyskuje dostęp do serwerów proxy interfejsu API powiązanych z usługą API powiązaną z aplikacją.

Możesz kontrolować proces zatwierdzania klucza dla każdej usługi API podczas tworzenia takiej usługi:

Proces zatwierdzenia może przebiegać:

• Automatycznie – gdy deweloper rejestruje aplikację, portal zwraca zatwierdzony klucz interfejsu API. Możesz później unieważnić automatycznie zatwierdzony klucz.
• Ręcznie – klucz interfejsu API jest zwracany przez portal, gdy deweloper rejestruje aplikację, ale nie jest on aktywowany w żadnej usłudze interfejsu API, która korzysta z ręcznego zatwierdzania klucza. Administrator musi ręcznie zatwierdzić klucz interfejsu API w interfejsie zarządzania brzegowym lub w interfejsie API, aby deweloper mógł go użyć do uzyskania dostępu do interfejsu API. Możesz później unieważnić ręcznie zatwierdzony klucz.

Więcej informacji znajdziesz w artykule o tworzeniu usług API.

Jeśli portal umożliwia deweloperowi dodawanie wielu usług API do aplikacji, może on dodawać niektóre z nich za pomocą automatycznego zatwierdzania kluczy, a jeszcze inne – ręcznie. Deweloper może od razu użyć zwróconego klucza interfejsu API w przypadku wszystkich automatycznie zatwierdzonych usług API, czekając na ostateczne zatwierdzenie usług, które wymagają ręcznego zatwierdzenia.

Aby wyświetlić listę usług API dla aplikacji oraz stan zatwierdzenia klucza dla takiej usługi, programista wybiera nazwę aplikacji na stronie Moje aplikacje, a następnie klika link Usługi:

W tym przykładzie usługa Premium Weather API korzysta z ręcznego zatwierdzania i czeka na zatwierdzenie klucza przez administratora. Bezpłatna usługa API korzysta z automatycznego zatwierdzania, a użycie klucza do uzyskiwania do niego dostępu zostało zatwierdzone.

Aby ręcznie zatwierdzić lub unieważnić klucz:

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

   

5. Wybierz nazwę aplikacji, którą chcesz zatwierdzić.
6. W prawym górnym rogu na stronie z informacjami o aplikacji kliknij przycisk Edytuj.
7. Na liście usług API w danej aplikacji, w sekcji Działania:
   • Aby zatwierdzić klucz, wybierz przycisk Zatwierdź dla każdej usługi interfejsu API, która wymaga ręcznego zatwierdzenia.
     

     

   • Aby unieważnić zatwierdzony klucz, wybierz przycisk Unieważnij w sekcji Działania dla usługi API mające na celu unieważnienie dostępu.
     

     

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

Kontrolowanie pamięci podręcznej produktu i aplikacji interfejsu API

Informacje o usługach API i aplikacjach dla deweloperów są przechowywane zdalnie z portalu w Apigee Edge. Oznacza to, że zmiany w usługach i aplikacjach API można wprowadzać z poziomu interfejsu użytkownika Edge lub API bez konieczności używania portalu. Jeśli na przykład administrator backendu doda nową usługę API, informacje w portalu nie zostaną natychmiast zaktualizowane.

Aby mieć pewność, że portal pozostaje zsynchronizowany z backendem brzegowym, możesz ręcznie aktywować aktualizację pamięci podręcznej portalu, automatycznie zaktualizować pamięci podręczne po uruchomieniu zadania cron w portalu lub wykonać obie te czynności. Jeśli na przykład skonfigurujesz zadanie cron tak, aby było uruchamiane często, np. co 5 lub 10 minut, możesz nie chcieć poświęcać zbyt dużo czasu na aktualizowanie usług API i pamięci podręcznej aplikacji dla deweloperów. W takiej sytuacji można ręcznie uruchomić aktualizację pamięci podręcznej. Jeśli jednak zadanie cron jest uruchamiane co godzinę lub 2 godziny, czas potrzebny na aktualizację pamięci podręcznych może nie mieć dużego wpływu.

Domyślnie portal jest skonfigurowany tak, aby po każdym uruchomieniu programu cron ponownie kompilować pamięć podręczną aplikacji interfejsu API i aplikacji dewelopera.

Aby określić, czy chcesz ponownie skompilować pamięć podręczną produktu API i aplikacji dewelopera przy każdym uruchomieniu cron:

1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub z uprawnieniami do tworzenia treści.
2. W menu Drupal wybierz Configuration > Dev Portal Settings > Application Settings (Konfiguracja > Ustawienia portalu dla programistów > Ustawienia aplikacji).
3. Zaznacz lub odznacz opcję Przebuduj pamięć podręczną usługi i aplikacji interfejsu API przy każdym uruchomieniu cron.
4. Zapisz ustawienia.

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

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

Dostosowywanie pól formularza używanych do rejestrowania aplikacji

Gdy deweloper zarejestruje aplikację, w portalu wyświetli się domyślny formularz:

Jako dostawca interfejsu API możesz zmodyfikować ten formularz, aby poprosić dewelopera o dodatkowe informacje, np. identyfikator klienta, platformę docelową aplikacji lub inne informacje. Portal umożliwia dodawanie nowych pól do tego formularza. Mogą to być te pola:

• Wymagany czy opcjonalny
• Wyświetlane przez różne elementy HTML, takie jak pola tekstowe, przyciski opcji czy pola wyboru
• Można ją skonfigurować tak, aby wyświetlała się w dowolnym miejscu w formularzu między polem URL wywołania zwrotnego a polem produktu

Na przykład ten formularz zawiera pole wymagane w przypadku identyfikatora klienta i opcjonalne pole dla platformy docelowej:

Gdy dodasz do formularza nowe pola, 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ć lub modyfikować te pola w Edge albo użyć interfejsu API do zarządzania Edge, aby uzyskać dostęp do tych pól za pomocą skryptu.

Możesz na przykład wyświetlić nowe pola formularza w interfejsie zarządzania Edge, klikając Opublikuj > Aplikacje dla programistów i wybierając nazwę aplikacji. Nowe wartości pól pojawią się w obszarze Atrybuty niestandardowe strony z nazwą odpowiadającą wewnętrznej nazwie pola:

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

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

Procedury poniżej opisują, jak skonfigurować formularze tworzenia aplikacji przy użyciu interfejsu administratora. Programista Drupal może wprowadzić dodatkowe zmiany, m.in. zmodyfikować stronę „Moje aplikacje” przy użyciu niestandardowych punktów zaczepienia. Aby dowiedzieć się więcej o sposobie zmiany zachowań za pomocą kodu, zapoznaj się z przykładami interfejsu API aplikacji w tym 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 z uprawnieniami do tworzenia treści.
2. Sprawdź, czy moduł Zarządzanie atrybutami aplikacji DevConnect jest włączony.
3. W menu administrowania Drupal wybierz Configuration > Dev Portal Settings > Dev Portal App Attributes (Konfiguracja > Ustawienia portalu dla programistów > Atrybuty aplikacji portalu dla programistów).
4. U góry strony kliknij przycisk Dodaj atrybut aplikacji Portalu dla programistów.
5. Skonfiguruj pole. Na przykład w powyższym polu Identyfikator klienta użyj tych ustawień:
   • Nazwa wewnętrzna = cust_id. To jest 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świetlaj ten atrybut.
   • Widżet = pole tekstowe
   • Wybierz Zapisz, aby wrócić na stronę Atrybuty aplikacji Portalu dla programistów.
6. Kliknij Zapisz zmiany.
7. W menu Drupal kliknij ikonę Strona główna > Wyczyść wszystkie pamięci podręczne.
   Zanim w formularzu pojawi się nowe pole, może być konieczne wyczyszczenie pamięci podręcznej przeglądarki.

Aby dodać opcjonalne pole, w którym deweloper może określić platformę aplikacji, ustaw te atrybuty pól:

• Nazwa wewnętrzna = dozwolone_platformy
• Nazwa publiczna = Platformy
• Opis = podaj co najmniej 1 platformę dla swojej aplikacji.
• Usuń zaznaczenie pól wyboru Wymagaj tego atrybutu
• Zaznacz pole wyboru Wyświetlaj ten atrybut.
• Widżet = lista pól wyboru
• Wybierz Zapisz, aby wrócić na stronę Atrybuty aplikacji Portalu dla programistów.

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

1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub z uprawnieniami do tworzenia treści.
2. W menu administrowania Drupal wybierz Configuration > Dev Portal Settings > Dev Portal App Attributes (Konfiguracja > Ustawienia portalu dla programistów > Atrybuty aplikacji portalu dla programistów).
3. Wybierz symbol plusa + w kolumnie Nazwa i przeciągnij właściwość w miejsce, w którym chcesz ją wyświetlić w formularzu.
4. Zapisz zmiany.