SMSEagle oferuje zaawansowane, wbudowane funkcjonalności REST API. API jest przeznaczone do integracji SMSEagle z dowolnym systemem zewnętrznym lub aplikacją.

Dokumentacja API (Referencja)

Urządzenie SMSEagle oferuje dwie wersje API: APIv2 i APIv1.

• API v2 – zalecane dla nowych projektów Nowoczesne API RESTful oparte na specyfikacji OpenAPI 3.0 Link do dokumentacji APIv2

• API v1 – dla istniejących projektów i wstecznej kompatybilności Proste API HTTP i JSONRPC Link do dokumentacji APIv1

Ze względu na obszerną treść dokumentacji API została ona przeniesiona do osobnego dokumentu. Skorzystaj z powyższych linków, aby znaleźć specyfikację każdego z API.

Dostęp do API

Zanim będzie można korzystać z API SMSEagle, należy włączyć dostęp do API w panelu web-GUI (menu Users). Poniżej znajduje się opis sposobu włączenia API na Twoim urządzeniu.

Zrzut ekranu z menu „Users” z zaznaczonym linkiem „Access to API”.

Dostęp może zostać przyznany do:

• APIv1

• APIv2

• Token dostępu do API może zostać wygenerowany lub wprowadzony ręcznie

• Dla APIv1 można przyznać uwierzytelnianie za pomocą użytkownika/hasła (używaj tego tylko dla wstecznej kompatybilności)

• Dla APIv2 można przyznać dostęp do zasobów innych użytkowników (utworzonych przez innych)

• Można przyznać szczegółowe uprawnienia dla metod w APIv1 i APIv2

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

W APIv1 użytkownik API (pojedynczy klucz API) domyślnie ma dostęp do zasobów wszystkich pozostałych użytkowników (kontaktów w książce telefonicznej, grup itd.). APIv2 jest bardziej szczegółowe w kwestii dostępu do zasobów: użytkownik API (pojedynczy klucz API) domyślnie ma dostęp tylko do zasobów utworzonych przez siebie. Jeśli chcesz zezwolić na dostęp do zasobów wszystkich innych użytkowników, musisz zaznaczyć pole wyboru „Access to resources of all users” w oknie Access to API.