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

Dokumentacja API (Referencje)

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

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

  • API v1 – dla istniejących projektów oraz zachowania wstecznej kompatybilności Proste API oparte na 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

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, jak włączyć API na 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 (należy stosować to wyłącznie w celu zachowania wstecznej kompatybilności)

  • 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ć 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 książki telefonicznej, grup itd.). APIv2 jest bardziej precyzyjne, jeśli chodzi o dostęp do zasobów: użytkownik API (pojedynczy klucz API) domyślnie ma dostęp tylko do zasobów utworzonych przez samego siebie. Jeśli chcesz umożliwić dostęp do zasobów wszystkich innych użytkowników, zaznacz pole wyboru „Access to resources of all users” w oknie Access to API.