Generischer Session-Akkumulierer-Adapter
Hier wird das Protokoll für generische Session-Akkumulierer beschrieben. Der Client ist Ihr Gerät, der Server ist die EApp-Plattform.
Session starten
Endpunkt: https://api.eapp.ai/v1/source-adapters/{authentifizierungs-id}/start
Anfrage (Client)
{
"token": "044A5DE3",
"device_id": "SomeCustomizableDeviceId",
"device_name": "Some customizable name",
"installation_id": "SomeCustomizableInstallationId",
"installation_name": "Some customizable installation name"
}
Antwort (Server)
Eine der folgenden:
Session erfolgreich gestartet
Statuscode: 200
{
"id": "session-start-registered",
"message": "",
"session_id": "5e3d1be5-7a6f-449a-ba8f-a9e85137b6e6",
"token_tag": "Appartment 3",
"device_tag": "Platformside Device Tag"
}
Autorisierung fehlgeschlagen
Statuscode: 401
{
"id": "charger-token-combination-not-found",
"message": "The given charger-token combination was not found"
}
Weitere Antworten
Andere Statuscodes (wie 404 oder 500) werden von diesem Endpunkt nicht ausgelöst und deuten deshalb mit grosser Wahrscheinlichkeit auf eine Fehlkonfiguration hin.
Session aktualisieren
Senden Sie periodisch ein Session-Update an den Server, damit der Verbrauch nachgeführt werden kann. Wurde die Session auf Seite der Plattform beendet, antwortet der Server mit 401: Die Session ist dann auch auf Seite des Clients zu beenden.
Anfrage (Client)
Endpunkt: https://api.eapp.ai/v1/source-adapters/{authentifizierungs-id}/update
{
"session_id": "5e3d1be5-7a6f-449a-ba8f-a9e85137b6e6",
"your_first_value": 123,
"your_second_value": 100
}
Antwort (Server)
Eine der folgenden:
Aktualisierung erfolgreich
Statuscode: 200
{
"id": "session-update-registered"
}
Session abgebrochen
Zeigt an, dass die Session auf Seite des Servers abgebrochen wurde.
Statuscode: 401
{
"id": "session-ended",
"message": "The session was canceled."
}
Weitere Antworten
Andere Statuscodes (wie 404 oder 500) werden von diesem Endpunkt nicht ausgelöst und deuten deshalb mit grosser Wahrscheinlichkeit auf eine Fehlkonfiguration hin.
Session beenden
Anfrage (Client)
Endpunkt: https://api.eapp.ai/v1/source-adapters/{authentifizierungs-id}/end
{
"session_id": "5e3d1be5-7a6f-449a-ba8f-a9e85137b6e6",
"your_first_value": 200,
"your_second_value": 100
}
Antwort (Server)
Session erfolgreich beendet
Statuscode: 200
{
"id": "session-end-registered",
"message": "The session was ended."
}
Weitere Antworten
Andere Statuscodes (wie 404 oder 500) werden von diesem Endpunkt nicht ausgelöst und deuten deshalb mit grosser Wahrscheinlichkeit auf eine Fehlkonfiguration hin.
Wiederholen Sie das Beenden einer Session, bis es erfolgreich war (200), damit keine Daten verloren gehen.