Integratoren

Fur wen die EV24® API gedacht ist

Die EV24® Integrations-API ist gedacht fur:

• Partner, die Kunden verwalten oder ausgewahlte Prozesse in ihrer Organisation automatisieren wollen,
• Kunden, die programmgesteuerten Zugriff auf Funktionen der Integrations-API benotigen,
• technische Teams, die System-zu-System-Integrationen mit EV24® umsetzen.

Zwei Arten von API

EV24® stellt zwei sich erganzende Integrationsmechanismen bereit. Die REST API dient dem aktiven Abfragen der Plattform und dem Ausfuhren von Operationen, wahrend Webhooks Ereignisbenachrichtigungen automatisch liefern, sobald auf der EV24®-Seite etwas geschieht.

In der Praxis nutzen Integrationen beide Mechanismen gemeinsam: ein Webhook signalisiert ein Ereignis, und die REST API erlaubt das Abrufen der zugehorigen Details.

Voraussetzungen fur den Zugriff

Um die EV24® API zu verwenden:

1. muss fur das Partner- oder Kundenprofil der API-Zugang aktiviert sein,
2. muss der Benutzer Zugriff auf den Bereich Einstellungen → API im Profil haben,
3. muss das API-Token im EV24® Portal generiert werden.

Die Aktivierung des API-Zugangs kann eine vorherige Freischaltung durch einen EV24® Administrator erfordern.

So erhalten Sie ein Token

REST API

Die REST API erlaubt Ihrem System, Daten in EV24® bei Bedarf zu lesen und zu schreiben — dazu gehoren unter anderem die Verwaltung von Ladestationen, RFID- / PIN-Token und Partnerkunden. Jede Anfrage wird mit einem Bearer-Token authentifiziert, und der Zugriff auf einzelne Operationen wird durch die dem Token im Portal zugewiesenen Scopes eingeschrankt.

Die API-Basisadresse lautet https://api.ev24.cloud. Die vollstandige interaktive OpenAPI-Spezifikation mit der kompletten Liste aller Endpoints, Parameter und Beispiele ist in der dedizierten API-Dokumentation verfugbar:

• EV24® API-Dokumentation 

Webhooks

Webhooks liefern Ereignisbenachrichtigungen der EV24®-Plattform an eine von Ihnen angegebene URL. Statt die REST API regelmassig abzufragen, erhalten Sie eine POST-Anfrage in dem Moment, in dem ein Ereignis eintritt.

Konfiguration

Geben Sie im Bereich Webhooks an:

• Endpoint-URL — die Adresse, an die EV24® Benachrichtigungen sendet (POST-Methode),
• Name und Wert des Authorization-Headers — ein beliebiger Header (z. B. X-Webhook-Secret), den EV24® jeder Anfrage hinzufugt, damit der empfangende Dienst die Herkunft der Benachrichtigungen bestatigen kann. Der Wert wird sicher gespeichert und nicht erneut angezeigt — geben Sie ihn beim Bearbeiten erneut ein, um ihn zu andern, oder lassen Sie das Feld leer, um den bisherigen zu behalten,
• die Ereignisse, die Sie empfangen mochten.

Verfugbare Ereignisse

Die Benachrichtigung wird als POST mit einem JSON-Payload gesendet. Die detaillierte Payload-Struktur je Ereignis ist in der EV24® API-Dokumentation  beschrieben.

Zustellung und Wiederholung

Benachrichtigungen werden in eine Warteschlange gestellt und asynchron zugestellt. Schlagt die Zustellung fehl (z. B. Netzwerkfehler oder ein Antwortcode ausserhalb von 2xx), wiederholt EV24® die Versuche gemass seiner Wiederholungsrichtlinie. Der empfangende Dienst sollte nach erfolgreicher Annahme mit einem 2xx-Code antworten und die Benachrichtigung idempotent verarbeiten — dasselbe Ereignis kann mehrfach zugestellt werden.

Sicherheitsregeln

• ubergeben Sie das Token im Header Authorization als Bearer,
• das Generieren eines neuen Tokens macht das vorherige sofort ungultig,
• das Token kann im Profil manuell widerrufen werden (Token widerrufen),
• sobald der API-Zugang deaktiviert wird, funktionieren alle zugehorigen Token nicht mehr,
• prufen Sie im empfangenden Dienst den von EV24® an jeden Webhook angehangten Authorization-Header.

Verwendung des Tokens

Beispiel fur den Authorization-Header:

Authorization: Bearer ev24_live_xxxxx.yyyyy

API-Basisadresse:

https://api.ev24.cloud

Die Endpoint-Dokumentation ist hier verfugbar:

• EV24® API