SMSEagle bietet leistungsstarke integrierte REST-API-Funktionen. Die API ist für die Integration von SMSEagle mit jedem beliebigen externen System oder jeder Anwendung vorgesehen.

API-Referenz (Dokumentation)

Das SMSEagle-Gerät bietet zwei API-Versionen: APIv2 und APIv1.

  • API v2 – empfohlen für neue Projekte Moderne RESTful-API basierend auf der OpenAPI-3.0-Spezifikation Link zur APIv2-Referenz

  • API v1 – für bestehende Projekte und Abwärtskompatibilität Einfache HTTP- und JSONRPC-API Link zur APIv1-Referenz

Aufgrund des umfangreichen Inhalts der API-Dokumentation wurde diese in ein separates Dokument verschoben. Folgen Sie den obigen Links, um die jeweilige Spezifikation der jeweiligen API zu finden.

API-Zugriff

Bevor Sie die SMSEagle API nutzen können, müssen Sie den API-Zugriff im Web-GUI (Menü Users) aktivieren. Nachfolgend finden Sie die Beschreibung, wie Sie die API auf Ihrem Gerät aktivieren können.

Screenshot aus dem Menü „Users“ mit markiertem Link „Access to API“.

Der Zugriff kann gewährt werden für:

  • APIv1

  • APIv2

  • API Access Token kann generiert oder eingegeben werden

  • Für APIv1 kann eine Benutzer/Passwort-Authentifizierung gewährt werden (nur zur Abwärtskompatibilität verwenden)

  • Für APIv2 kann Zugriff auf Ressourcen anderer Benutzer (von anderen erstellt) gewährt werden

  • Es können spezifische Berechtigungen für Methoden in APIv1 & APIv2 gewährt werden

Zugriff auf Ressourcen anderer Benutzer in der API

In APIv1 hat ein API-Benutzer (einzelner API-Schlüssel) standardmäßig Zugriff auf Ressourcen aller anderen Benutzer (Telefonbuchkontakte, Gruppen usw.). APIv2 ist beim Ressourcenzugriff granularer: Ein API-Benutzer (einzelner API-Schlüssel) hat standardmäßig Zugriff auf die von ihm selbst erstellten Ressourcen. Wenn Sie den Zugriff auf Ressourcen aller anderen Benutzer erlauben möchten, müssen Sie das Kontrollkästchen „Access to resources of all users“ im Fenster Access to API aktivieren.