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

API Reference (Dokumentacja)

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 to APIv2 Reference

• API v1 – dla istniejących projektów oraz zachowania kompatybilności wstecznej Proste API HTTP i JSONRPC Link to APIv1 Reference

Ze względu na obszerną zawartość 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 interfejsie webowym (menu Users). Poniżej znajduje się opis, jak włączyć API na swoim 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żna wygenerować lub wprowadzić ręcznie

• Dla APIv1 można przyznać uwierzytelnianie za pomocą użytkownika/hasła (używać wyłącznie w celu zachowania kompatybilności wstecznej)

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

• Dla metod w APIv1 i APIv2 można przyznać konkretne uprawnienia

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 innych użytkowników (kontaktów w książce telefonicznej, grup itp.). APIv2 jest bardziej szczegółowe pod względem dostępu do zasobów: użytkownik API (pojedynczy klucz API) domyślnie ma dostęp do zasobów utworzonych przez siebie. Jeśli chcesz zezwolić na dostęp do zasobów wszystkich innych użytkowników, musisz zaznaczyć checkbox „Access to resources of all users” w oknie Access to API.