SMSEagle oferuje potężny wbudowany REST API. API jest przeznaczony do integracji SMSEagle z dowolnym systemem zewnętrznym lub aplikacją.

Dokumentacja API

SMSEagle oferuje dwie wersje API:

  • API v2 - zalecane, używaj go do każdej nowej integracji. Nowoczesne RESTful API oparte na specyfikacji OpenAPI 3.0. Dokumentacja API v2

  • API v1 - starsze API, zachowane dla wstecznej kompatybilności. Proste API oparte na HTTP i JSON-RPC. Wciąż działa i jest wspierane, ale nie otrzymuje nowych funkcji - nie twórz nowych integracji względem niego. Dokumentacja API v1

Ze względu na obszerną zawartość dokumentacji API, jest ona przechowywana jako osobny dokument. Kliknij powyższe linki, aby otrzymać pełną specyfikację każdego API.

Klucze API

Integracja uwierzytelnia się za pomocą klucza API zamiast hasła użytkownika. Klucze są przechowywane osobno dla każdej wersji API, na dwóch stronach:

  • Settings > API > API v2 (/settings/api/v2)

  • Settings > API > API v1 (/settings/api/v1)

Klucz zawsze należy do użytkownika i działa jako ten użytkownik, więc widzi wiadomości i kontakty tego użytkownika. Uprawnienia są przydzielane dla każdego klucza, co pozwala na ograniczenie systemu monitorującego do tylko odczytu, podczas gdy formularz na stronie internetowej może tylko wysyłać.

Klucze API v2

To jest strona do użytku dla nowej integracji.

Strona kluczy API v2 wymieniająca każdy klucz z jego właścicielem, uprawnieniami i ostatnim użyciem (przykładowe wartości)

Klucze API v2

Klucze API v1

API v1 jest starszym API. Utwórz klucz v1 tylko dla istniejącej integracji, której nie można przenieść do v2 - dla wszystkiego nowego utwórz zamiast tego klucz API v2.

Strona kluczy API v1 wymieniająca każdy klucz z jego właścicielem, uprawnieniami i ostatnim użyciem (przykładowe wartości)

Klucze API v1

Tworzenie klucza

Create API key otwiera formularz dla wersji API, której strona się znajduje:

Pole

Co to robi

Key name

Jak rozpoznasz tę integrację później, na przykład Zabbix lub Website form.

Owner

Użytkownik, jako który działa klucz. Klucz widzi wiadomości i kontakty tego użytkownika.

Key enabled

Wyłączony klucz jest odrzucany przez API bez jego usunięcia, co wyłącza integrację bez utraty jej konfiguracji.

Access to all users» resources

Tylko API v2. Pozwala kluczowi czytać i zmieniać zasoby należące do innych użytkowników (patrz poniżej).

Uprawnienia

Tylko metody, które włączysz, mogą być wywoływane za pomocą tego klucza.

Klucz jest wyświetlany tylko raz, zaraz po jego utworzeniu. Skopiuj go wtedy i przechowuj w bezpiecznym miejscu. Jeśli go zgubisz, odwołaj ten klucz i utwórz nowy - pozostałe klucze tego samego użytkownika będą nadal działać.

Którzy użytkownicy mają dostęp do API

System > Users pokazuje dla każdego użytkownika, ile kluczy API ma użytkownik i dla której wersji API. Badge bezpośrednio prowadzi do odpowiedniej strony kluczy.

Kolumna dostępu do API na liście użytkowników, pokazująca liczbę kluczy na użytkownika

Dostęp do API, pokazany dla każdego użytkownika na liście użytkowników

Dostęp do zasobów innych użytkowników

Dwie wersje API różnią się tym, jak szeroko klucz API może widzieć dane innych użytkowników:

  • W API v1 klucz ma domyślnie dostęp do zasobów każdego innego użytkownika - kontaktów z książki adresowej, grup itd.

  • W API v2 dostęp jest bardziej granularny: klucz ma domyślnie dostęp tylko do zasobów, które sam utworzył. Aby umożliwić dostęp do zasobów wszystkich innych użytkowników, włącz Access to all users» resources na kluczu.