Przegląd

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.

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:

1. Przejdź do "Ustawienia" > "Klucze API", a następnie kliknij "Utwórz".
   
2. Podaj nazwę dla Klucza API.
3. Wybierz datę wygaśnięcia. Pamiętaj, że nie można jej przedłużyć po utworzeniu Klucza API.
4. 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 są następujące role:
   • Phone System Queues Monitor: ta rola jest wymagana do korzystania z modułu SIP Caller Queues Monitor i monitorowania Twojego systemu telefonicznego w czasie rzeczywistym.
   • Czytelnik Kampanii (Campaign Reader): ta rola pozwala odczytywać kampanie i numery kampanii.
   • Administrator Kampanii (Campaign Admin): ta rola pozwala duplikować kampanie, zmieniać stan kampanii i usuwać kampanie.
   • Administrator Numerów Kampanii (Campaign Number Admin): ta rola pozwala dodawać i usuwać numery z kampanii.
   • Dostawca Numerów Kampanii (Campaign Number Provider): ta rola pozwala dodawać numery do kampanii.
5. Kliknij "Zapisz", aby utworzyć Klucz API.
   
6. 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.

Edytowanie Klucza API

Aby edytować Klucz API:

1. Przejdź do "Ustawienia" > "Klucze API", a następnie kliknij Klucz API, który chcesz edytować.
   
2. 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ć:

1. Przejdź do "Ustawienia" > "Klucze API", a następnie wybierz Klucz API, który chcesz usunąć.
2. Kliknij przycisk Usuń i potwierdź operację.