Der E-Coach verfügt über eine REST-API als Schnittstelle. Damit können Drittprogramme oder Prozesse an den E-Coach angebunden werden.
Sicherheit
Um für unbefugte den Zugriff auf die Schnittstelle zu beschränken, wurden folgende Sicherheitsmaßnahmen umgesetzt:
- alle Anfragen erfolgen ausschließlich mit TLS-Verschlüsselung (https)
- alle Anfragen erfordern eine Autorisierung (Bearer Token)
- es existiert eine Limitierung der möglich Anfragen (Vermeidung von Denial-of-Service-Attacken)
Authentifizierung
Zur Nutzung der API ist ein Nachweis der eigenen Identität erforderlich. Dies setzt einen User im E-Coach voraus, mit dessen Zugangsdaten (E-Mail und Passwort) ein JSON-Web-Token generiert werden kann, welcher bei jeder Anfrage im Header als Bearer-Token übergeben werden muss. Die Rollenzuordnung des Users bestimmt, auf welche Endpunkte und Daten die API Zugriff hat.
Beispielanfrage für die Authentifizierung
curl -X POST "https://api.ecoach.cloud/api/auth" \
-H "Tenant: <<TENANT>>" \
-H "Content-Type: application/json" \
-d '{
"email": "<<EMAIL>>",
"password": "<<PASSWORD>>"
}'Beispiel-Antwort bei erfolgreichen Authentifizierung:
{
"token": "eyJh*****mqBES_8_o",
"refreshToken": "KYARbBeOEw4+pkAGb7r7HHXjNgZshJlYqGbpVWBi1zo=",
"refreshTokenExpiryTime": "2025-07-30T10:45:41.4599978Z"
}Der Token muss in allen Folgeanfragen als Bearer-Token im Header übergeben werden
curl -X GET "https://api.ecoach.cloud/api/users/me" \ -H "Authorization: Bearer <<TOKEN>>" \ -H "Content-Type: application/json" \
Format
Die Antworten werden im JSON-Format ausgegeben.
Endpunkte
Die Endpunkte der API sind mit Hilfe einer interaktiven Webseite dokumentiert, über welche sie direkt genutzt/getestet werden können.
https://api.ecoach.cloud/swagger
Die Dokumentation kann auch als OpenAPI-Spezifikation heruntergeladen werden, um sie in Drittprogrammen wie Postman zu verwenden.