Integracja API i Deweloperska
SMSEagle oferuje potężny wbudowany REST API. API jest dedykowane 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, utrzymywane wyłącznie dla kompatybilności wstecznej. Proste API HTTP i JSON-RPC. Nadal działa i jest wspierane, ale nie otrzymuje nowych funkcji - nie pisz nowych integracji wobec niego. Dokumentacja API v1
Ze względu na obszerną zawartość dokumentacji API jest ona utrzymywana jako oddzielny dokument. Przejdź do powyższych linków, aby uzyskać 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, więc widzi jego wiadomości i kontakty. Uprawnienia są przyznawane na klucz, co pozwala ograniczyć system monitorowania do odczytu, podczas gdy formularz internetowy może tylko wysyłać.
Klucze API v2
Jest to strona do użycia dla nowej integracji.
Klucze API v1
API v1 jest starszym API. Utwórz klucz v1 wyłącznie dla istniejącej integracji, której nie można przenieść do v2 - dla wszystkiego nowego, utwórz klucz API v2 zamiast tego.
Tworzenie klucza
Create API key otwiera formularz dla wersji API, na której stronie się znajdujesz:
Pole |
Co robi |
|---|---|
Key name |
Sposób, w jaki rozpoznasz tę integrację później, na przykład Zabbix lub Website form. |
Owner |
Użytkownik, którym działa klucz. 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 odczytywać 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 przechowaj w bezpiecznym miejscu. Jeśli go zgubisz, odwołaj ten klucz i utwórz nowy - inne klucze tego samego użytkownika nadal będą działać.
Którzy użytkownicy mają dostęp do API
System > Users pokazuje dla każdego użytkownika, ile kluczy API posiada i dla jakiej wersji API. Znaczek linków bezpośrednio do pasującej strony kluczy.
Dostęp do API, pokazany dla każdego użytkownika na liście Użytkownicy
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 adresowej, grupy itd.
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.