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

  • API v1 – dla istniejących projektów oraz zachowania zgodności wstecznej Proste API oparte na 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 rozpoczęciem korzystania z API SMSEagle musisz włączyć dostęp do API w panelu web-GUI (menu Users). Poniżej znajduje się opis, jak włączyć 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

  • 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)

  • Poszczególne uprawnienia mogą zostać przyznane 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 innych użytkowników (kontakty w książce telefonicznej, grupy itd.). APIv2 jest bardziej precyzyjne w zakresie 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ć checkbox „Access to resources of all users” w oknie Access to API.