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 do każdej nowej integracji. Nowoczesne RESTful API oparte na specyfikacji OpenAPI 3.0. Dokumentacja API v2

  • API v1 - starsze API, zachowane dla kompatybilności wstecz. Proste API HTTP i JSON-RPC. Nadal działa i jest wspierane, ale nie otrzymuje nowych funkcji - nie pisz nowych integracji dla tego API. Dokumentacja API v1

Ze względu na obszerną zawartość dokumentacji API, jest ona utrzymywana jako osobny dokument. Skorzystaj z linków powyżej, aby zapoznać się z pełną specyfikacją każdego API.

Klucze API

Integracja uwierzytelnia się za pomocą klucza API zamiast hasła użytkownika. Klucze są przechowywane oddzielnie 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, dlatego widzi wiadomości i kontakty tego użytkownika. Uprawnienia przyznawane są na klucz, co pozwala ograniczyć system monitorowania do odczytu, podczas gdy formularz internetowy może tylko wysyłać.

Klucze API v2

To jest strona do wykorzystania dla nowej integracji.

Strona kluczy API v2 z listą każdego klucza z właścicielem, uprawnieniami i ostatnią datą użycia (wartości przykładowe)

Klucze API v2

Klucze API v1

API v1 to starsze 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 z listą każdego klucza z właścicielem, uprawnieniami i ostatnią datą użycia (wartości przykładowe)

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, którego klucz reprezentuje. Klucz widzi wiadomości i kontakty tego użytkownika.

Key enabled

Wyłączony klucz jest odrzucany przez API bez usuwania, 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 sam jest wyświetlany raz, zaraz po jego utworzeniu. Skopiuj go wtedy i przechowuj w bezpiecznym miejscu. Jeśli go stracisz, odwołaj ten klucz i utwórz nowy - inne klucze tego samego użytkownika będą dalej 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. Odznaka prowadzi bezpośrednio do pasującej strony kluczy.

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

Dostęp do API, pokazywany na użytkownika na liście Users

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 - kontakty z książki telefonicznej, grupy i tak dalej.

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