Ustawienia
Klucze API
SIP Caller pozwala definiować klucze API, aby integrować go z systemami zewnętrznymi. Możesz zdefiniować tyle kluczy API, ile potrzebujesz, przypisując datę wygaśnięcia i role. System zewnętrzny może korzystać z REST API udostępnianego przez SIP Caller, uwierzytelniając się za pomocą tokenu klucza API wygenerowanego zgodnie z opisem poniżej.
Klucze API wymagają planu Enterprise.
Wymagane role
Aby utworzyć lub edytować klucz API, użytkownik potrzebuje jednej z następujących ról:
- Administrator
Aby wyświetlić klucz API, użytkownik potrzebuje jednej z następujących ról:
- Czytelnik konta
Tworzenie klucza API
Aby utworzyć klucz API:
- Przejdź do "Ustawienia" > "Klucze API", a następnie kliknij "Utwórz".
- Podaj nazwę dla klucza API.
- Wybierz datę wygaśnięcia. Pamiętaj, że nie można jej przedłużyć po utworzeniu klucza API.
- Włącz role, które chcesz przyznać aplikacjom korzystającym z tego klucza API. Pamiętaj, że nie można ich zmienić po utworzeniu klucza API. Dostępne role opisano w sekcji Role kluczy API.
- Kliknij "Zapisz", aby utworzyć klucz API.
- Zostanie wyświetlone okno dialogowe zawierające token dla właśnie utworzonego klucza API. Skopiuj wartość i zapisz ją w bezpiecznym miejscu. Ten token nie zostanie wyświetlony ponownie i nie można go odzyskać, ponieważ SIP Caller go nie przechowuje. Jeśli go utracisz, będziesz musiał utworzyć kolejny klucz API.
Role kluczy API
Role przypisane do klucza API określają, co mogą robić korzystające z niego aplikacje. Dostępne są następujące role:
- Monitor kolejek systemu telefonicznego: ta rola jest wymagana do korzystania z modułu SIP Caller Queues Monitor i monitorowania Twojego systemu telefonicznego w czasie rzeczywistym, w przypadku kampanii działających w trybie dialera predykcyjnego lub progresywnego. Można ją ograniczyć do wybranych systemów telefonicznych.
- Czytelnik kampanii: ta rola zapewnia dostęp tylko do odczytu do kampanii, numerów kampanii, czarnych list, list kontaktów i raportów kampanii.
- Administrator kampanii: ta rola zapewnia pełny dostęp do kampanii, numerów kampanii, czarnych list, list kontaktów i raportów kampanii.
- Administrator numerów kampanii: ta rola pozwala odczytywać, dodawać i usuwać numery kampanii. Można ją ograniczyć do wybranych kampanii.
- Dostawca numerów kampanii: ta rola pozwala dodawać numery do kampanii, bez możliwości ich odczytywania ani usuwania. Można ją ograniczyć do wybranych kampanii.
Przyznawaj każdej aplikacji tylko te role, których potrzebuje. Na przykład formularz internetowy, który wysyła nowe leady do kampanii, potrzebuje jedynie roli Dostawca numerów kampanii, ograniczonej do tej kampanii. Więcej szczegółów znajdziesz w dokumentacji dla deweloperów.
Edytowanie klucza API
Aby edytować klucz API:
- Przejdź do "Ustawienia" > "Klucze API", a następnie kliknij klucz API, który chcesz edytować.
- W tym momencie możesz edytować tylko nazwę oraz przeglądać datę i godzinę utworzenia i wygaśnięcia oraz role przypisane do klucza API. Jeśli musisz zmienić inne wartości, będziesz musiał utworzyć kolejny klucz API.
Usuwanie klucza API
Gdy musisz odwołać dostęp aplikacji do SIP Caller, musisz usunąć klucz API. Aby to zrobić:
- Przejdź do "Ustawienia" > "Klucze API", a następnie wybierz klucz API, który chcesz usunąć.
- Kliknij przycisk Usuń i potwierdź operację.
