Entwickler (API)

Neben der App bietet die ANABOX smart auch eine API mit der Entwickler individuelle Anwendungen oder bestehende Systeme integrieren können.

Was bietet die ANABOX smart API?

Die ANABOX smart API ist speziell darauf ausgelegt, die Funktionen des Medikamentenspenders und der dazugehörigen App in Ihre Anwendungen einzubinden. Damit können Sie z. B.:

• Medikationspläne abrufen: Greifen Sie auf Medikationsdaten zu, um diese in externe Systeme zu integrieren.
• Benachrichtigungen verwalten: Push-Benachrichtigungen oder Erinnerungen über Ihre App oder Plattform steuern.
• Daten synchronisieren: Synchronisieren Sie Medikamenteneinnahmen, Nutzungsstatistiken oder andere Daten in Echtzeit.

Die Memo API ist die REST-basierte Schnittstelle, die sowohl die Anabox Smart als auch das paperlesspaper ePaper-Display antreibt. Sie ermöglicht das Lesen und Schreiben derselben Daten, die auch von den Memo Mobile- und Web-Apps verwendet werden. So können Medikamentenpläne, Erinnerungslogiken oder dynamische Bildschirminhalte direkt in Ihre eigene Software und Hardware integriert werden.

Warum eine API für zwei sehr unterschiedliche Produkte?
Beide Geräte verwenden denselben Backend-Dienst: memo.wirewire.de.

• Anabox smart benötigt zuverlässige Zeitpläne, Einnahmebestätigungen und Push-Erinnerungen.
• paperlesspaper benötigt aktuelle Bilder, Kalender-Feeds und andere Widgets, die auf das stromsparende Display übertragen werden.

Da das Memo-Backend bereits Pläne, Benachrichtigungen und gerenderte „Apps“ speichert, bedeutet einmalige Integration doppelten Nutzen: Sie können z. B. einen Medikamentenplan aktualisieren und gleichzeitig mit denselben Authentifizierungs- und Schlüsselmechanismen eine Wetterkarte auf ein E-Ink-Display übertragen.

Erste Schritte

Um die Memo API zu verwenden, müssen Sie:

• Einen gültigen API-Schlüssel verwenden, um Anfragen an die API-Endpunkte zu senden.
  Ihren API-Schlüssel erhalten Sie in der Memo-Anwendung.
• Nur HTTPS-Verbindungen sind erlaubt. Anfragen über HTTP werden per HTTP 301-Redirect auf HTTPS umgeleitet.
• Die API gibt Antworten im JSON-Format zurück. Fehler erscheinen im JSON-Body unter dem Schlüssel error.

Wie melde ich mich für die API an?

Bitte senden Sie uns eine Nachricht an info@anabox-smart.de zur Anmeldung.

Freigeschaltetet Accounts können dann API-Keys in Ihren Benutzereinstellungen generieren.

Wo finde ich die Dokumentation der API?

Sie finden die Dokumentation hier.

Anwendungsbeispiele der ANABOX smart API

Die API bietet zahlreiche Möglichkeiten, um innovative Lösungen zu schaffen. Hier sind einige Beispiele:

• Pflegemanagementsysteme: Automatische Synchronisation von Medikationsplänen mit Pflegeplattformen.
• Telemedizinische Anwendungen: Anzeige von Medikamenteneinnahmedaten für Ärzte oder Pflegekräfte in Echtzeit.
• Benutzererinnerungen: Anpassung von Erinnerungsfunktionen an spezifische Benutzerbedürfnisse.

Authentifizierung

Die Memo API verwendet zwei Authentifizierungsmethoden:
Eigene API-Tokens und Auth0 JWT-Tokens.

API-Token-Authentifizierung

Sie können ein benutzerdefiniertes API-Token in der Memo-App oder über Ihren Administrator generieren.
Zur Authentifizierung fügen Sie das API-Token dem Authorization-Header als Bearer-Token hinzu:

Authorization: Bearer <Ihr-Token>

• Das API-Token muss ein 64-stelliger Hexadezimalwert sein.
• Ist das Token gültig, wird die Anfrage im Namen des zugehörigen Benutzers authentifiziert.

Auth0 JWT-Authentifizierung

Falls kein gültiges API-Token übermittelt wurde, greift die API auf Auth0 JWT zurück.
Ein JWT erhalten Sie durch Login in die Memo-Webanwendung oder über den Auth0-Zugang Ihrer Organisation.

Fügen Sie das JWT ebenfalls im Authorization-Header hinzu:

Authorization: Bearer <Ihr-JWT>

Fehlermeldungen zur Authentifizierung

• 401 Unauthorized: Token fehlt, ist ungültig oder abgelaufen.
• 403 Forbidden: Authentifiziert, aber keine Berechtigung für den Endpunkt.

Rate- und Nutzungslimits

Die Zugriffsbeschränkungen gelten pro API-Key und Zeiteinheit.
Das Limit beträgt 300 Anfragen pro Minute.
Zusätzlich können je nach Tarif weitere Nutzungslimits gelten.
Bei Überschreiten erhalten Sie den HTTP-Status 429 Too Many Requests.

HTTP 503 Antwort

Ein HTTP-503-Fehler zeigt eine unerwartete Spitzenlast im API-Zugriff.
Der Server ist in der Regel innerhalb von fünf Minuten wieder verfügbar.
Bei anhaltender Störung oder anderen HTTP 5XX-Fehlern wenden Sie sich bitte an den Support.

Deep Linking in die App

Die App unterstützt Deep Linking, wodurch sich Benutzer aus anderen Anwendungen oder Webseiten direkt zu bestimmten Funktionen oder Seiten in der App navigieren lassen.

Beispiel

https://memo.wirewire.de/account

Verlinkt, wenn die App installiert ist direkt in die Accounteinstellungen

https://memo.wirewire.de/account#no_universal_links

Mit dem Hash #no_universal_link kann das Deep Linking deaktivert werden.

Bei Fragen steht unser Support-Team unter info@anabox-smart.de zur Verfügung.