SMSEagle udostępnia zaawansowane, wbudowane funkcjonalności REST API. API jest przeznaczone do integracji SMSEagle z każdym systemem zewnętrznym lub aplikacją.

Dokumentacja API (Referencje)

Urządzenie SMSEagle udostępnia dwie wersje API: APIv2 oraz APIv1.

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

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

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

Przed skorzystaniem z API SMSEagle musisz włączyć dostęp do API w interfejsie webowym (menu Users). Poniżej znajdziesz 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 dla:

• APIv1

• APIv2

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

• Dla APIv1 może zostać przyznana autoryzacja za pomocą użytkownika/hasła (używaj tego tylko dla zachowania kompatybilności wstecznej)

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

• Dla metod w APIv1 i APIv2 mogą zostać przyznane szczegółowe 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 w zakresie 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.