SMSEagle oferuje zaawansowane, wbudowane funkcjonalności REST API. API jest przeznaczone do integracji SMSEagle z każdym 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 RESTful oparte na specyfikacji OpenAPI 3.0 Link to APIv2 Reference

  • API v1 – dla istniejących projektów i zachowania zgodnoś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

Przed skorzystaniem z API SMSEagle musisz włączyć dostęp do API w panelu web-GUI (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”.

Access to API window with APIv1/APIv2 checkboxes, access token and permission list

Access to API window with APIv2 method permissions

Dostęp można przyznać do:

  • APIv1

  • APIv2

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

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

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

  • W APIv1 i APIv2 można przyznać konkretne uprawnienia dla poszczególnych metod

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 z książki telefonicznej, grup itd.). APIv2 jest bardziej szczegółowe w zakresie dostępu 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 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.