Podczas konfigurowania nowego Aplikacja użytkownika, będziesz pracować z kilkoma kluczowymi konfiguracjami, które określają, w jaki sposób Twoja aplikacja zewnętrzna integruje się z platformą. Przyjrzyjmy się bliżej każdemu istotnemu komponentowi.
Zacznij od kliknięcia + przycisk w Aplikacje użytkownika lista. W wyświetlonym formularzu konfiguracyjnym wykonaj następujące kroki:
Skonfiguruj adres URL
Określ adres URL swojej aplikacji — adres, pod którym hostowana jest Twoja aplikacja. Stanowi on podstawę integracji.
- Upewnij się, że adres URL jest prawidłowy, korzysta z połączenia HTTPS, prowadzi do godnego zaufania zasobu i zawiera nie więcej niż 1000 znaków.
- Upewnij się, że aplikacja ma włączone ustawienie iFrame po swojej stronie, w przeciwnym razie nie będziesz mógł go otworzyć w interfejsie platformy.
Skonfiguruj podstawowe parametry
Aby spersonalizować aplikację, możesz uwzględnić różne parametry w adresie URL. Możesz ręcznie dodać parametry w polu adresu URL lub skorzystać z jednej z naszych sugestii: język, identyfikator użytkownika lub strefa czasowa. Kliknij na sugestię parametru, aby dodać ją na końcu adresu URL. Rozwiń poniższy opis, aby dowiedzieć się więcej o sugerowanych parametrach i przykładach.
Zrozumienie sugerowanych parametrów adresu URL:
- Sugerujemy kilka podstawowych parametrów personalizacji
?locale={locale_code}Parametr języka, który automatycznie odpowiada językowi platformy użytkownika.- Przykład:
https://your-app.com/dashboard?locale=en ?user_id={user_identifier}Parametr kontekstu użytkownika, który przekazuje tożsamość użytkownika w celu filtrowania spersonalizowanych informacji.- Przykład:
https://your-app.com/dashboard?user_id=12345 ?timezone={timezone}Parametr czasu, który automatycznie dopasowuje się do strefy czasowej platformy użytkownika.- Przykład:
https://your-app.com/dashboard?timezone=UTC+1 - Możesz edytować sugerowaną nazwę parametru lub określić dla niej określoną wartość.
Przykład adresu URL aplikacji z parametrami
Przetestuj konfigurację, aby upewnić się, że aplikacja ładuje się poprawnie. Kliknij „Odśwież” aby wyświetlić podgląd.
Dostosuj wygląd
Utwórz rozpoznawalną tożsamość swojej aplikacji, aby ułatwić do niej dostęp. Poniższe ustawienia pomogą Ci to zrobić:
- Etykieta – Dodaj unikalną, opisową nazwę swojej aplikacji (do 24 znaków). Zostanie to pokazane na pasku bocznym platformy.
- Opis – Dodaj krótkie wyjaśnienie ze szczegółami dotyczącymi funkcjonalności aplikacji lub zaznacz ważne informacje (do 50 znaków). Informacyjny opis pomoże Twoim użytkownikom lepiej zrozumieć cel aplikacji.
- Ikona – Wybierz ikonę reprezentującą funkcję Twojej aplikacji, aby uzyskać jeszcze bardziej natywną nawigację.
Wybierz metodę wyświetlania
Zdecyduj, jak otworzy się Twoja aplikacja, wybierając jedną z dwóch opcji w Otwórz w rozwijana lista:
- Osadzony – Aplikacja pojawia się w interfejsie platformy
- Nowa karta – Aplikacja otwiera się w osobnej karcie przeglądarki
Nasza platforma wykorzystuje iFrame do osadzania. Ponieważ nie wszystkie adresy URL można pomyślnie przetworzyć za pomocą tej technologii, pamiętaj o wyświetleniu podglądu wyniku osadzania. Jeśli napotkasz jakiekolwiek problemy z tą metodą wyświetlania, rozważ użycie Nowa karta.
Skonfiguruj uwierzytelnianie (opcjonalnie)
Skonfiguruj uwierzytelnianie, jeśli Twoja aplikacja opiera się na interfejsie API platformy. W takim przypadku platforma przekaże dane uwierzytelniające bezpośrednio do aplikacji po jej otwarciu, eliminując potrzebę implementacji dodatkowej funkcjonalności logowania po stronie aplikacji. Możesz wybrać jedną z dwóch metod uwierzytelniania:
- Klucz API
- Metoda ta jest przeznaczona dla aplikacji, w których zarządzanie rolami lub uprawnienia użytkownika nie są wymagane.
- Klucz API odpowiada poziomowi dostępu właściciela konta. Oznacza to, że zapewnienie wspólnemu użytkownikowi klucza API może zapewnić mu dostęp do wszystkie dane dostępne dla głównego użytkownika. Na przykład, jeśli Twoja aplikacja współpracuje z trackerami, do których użytkownik ma ograniczone prawa lub nie ma do nich żadnego dostępu, użycie klucza API nadal spowoduje udostępnienie wszystkich trackerów z konta głównego.
- Klucz sesji
- Metodę tę zaleca się w przypadku zarządzania rolami.
- Przesyła bieżący klucz sesji użytkownika do aplikacji.
Wybór Klucz API metoda automatycznie wyłączy Klucz sesji metoda i odwrotnie. Na raz można zastosować tylko jedną metodę.
Po włączeniu uwierzytelniania platforma dołącza ?session_key= parametr adresu URL Twojej aplikacji.
- Jeśli wybrałeś Klucz API, wartość parametru będzie zawierać ten klucz.
- Jeśli zdecydowałeś się na Klucz sesji, wartość parametru będzie zawierać klucz bieżącej sesji użytkownika, z której uzyskuje się dostęp do aplikacji.
Upewnij się, że aplikacja jest w stanie odczytać i użyć tego parametru.
Zapisz nową aplikację
Kliknij Zapisz guzik. Twoja aplikacja pojawi się w Aplikacje użytkownika lista i pasek boczny platformy. Włączone aplikacje automatycznie stają się dostępne dla użytkowników konta.
Przykład widoku aplikacji użytkownika wbudowanego
Jeśli Twoja aplikacja nie wyświetla się prawidłowo po osadzeniu, spróbuj:
- Zamiast tego otwórz go w nowej karcie
- Weryfikacja poprawności i dostępności adresu URL
- Sprawdzanie, czy wszystkie parametry są poprawnie sformatowane
Utworzone aplikacje pozostają w pełni konfigurowalne po ich zapisaniu. W każdej chwili możesz dostosować ich parametry i wygląd. Aby dowiedzieć się więcej o zarządzaniu aplikacjami, zobacz Zarządzanie istniejącymi aplikacjami użytkownika.