Inhalte werden geladen...
Inhalte werden geladen...

1.0 Authentifizierung

Die zevvy API unterstützt die Flows «authorization_code» und «device». Der «device Flow» wird bevorzugt für mobile oder eingebettete Anwendungen verwendet, während der "authorization_code Flow" für Webanwendungen genutzt wird.

Für unsere Anwendung wird normalerweise der "device Flow" verwendet.

Folgende Daten werden für eine erfolgreiche Authentifizierung benötigt:

• client_id
• client_secret

(Wenn Sie noch keine Client ID haben, können Sie uns für die Erstellung der Client ID kontaktieren)

Sie erhalten anschliessend eine Antwort mit folgenden Daten:

• device_code
• user_code
• client_secret
• verification_uri
• verification_uri_complete
• interval

Code Beispiel
java python javascript shell php

Antwort
json
Inhalte werden geladen...
Inhalte werden geladen...

1.2 Access Token generieren

Um einen Access Token abzurufen, müssen Sie eine Anfrage mit den folgenden Angaben aus dem vorherigen Request senden:

• device_code
• client_id
• client_secret

Zusätzlich müssen Sie den scope und grant_type angeben.

Hier sind die verfügbaren Scopes:

offline_access: Erforderlich, damit das Aktualisierungstoken eine längere Gültigkeitsdauer für den langfristigen Gebrauch hat.
measurement: Erforderlich zur Verwaltung von Messungen.
register: Erforderlich zur Verwaltung von Registern.
device: Erforderlich zur Verwaltung von Geräten.

Stellen Sie sicher, dass Sie diese Angaben in Ihrer Anfrage korrekt übermitteln, um einen gültigen Access Token zu erhalten.

Code Beispiel
java python javascript shell php

Antwort
json

2.0 Gerät in zevvy erstellen

Mit dem Token vom vorherigen Schritt (<LONG_ACCESS_TOKEN>) kann die API nun genutzt werden, um zum Beispiel ein Gerät zu erstellen.

Dabei müssen lediglich folgende Daten an den Endpunkt gesendet werden:

• Access Token
• Name
• Referenz (optional)

Bitte darauf achten, dass der Access Token im Header untergebracht ist und der Name (Name) sowie die Referenz (Reference) als JSON im Body mitgesendet werden sollen.

Code Beispiel
java python javascript shell php

Antwort
json

3.0 Beispiel: Ladestation mit 15min Werte

Im vorherigen Beispiel haben wir angeschaut, wie man einzelne Geräte in zevvy per API eröffnen kann. Bei grossen Datenmengen ist es aber von Vorteil, wenn die Geräte nicht mit einzelnen API-Verbindungen erstellt werden müssen.

Unsere API erkennt automatisch, ob ein Gerät oder Register existiert oder nicht. Falls nicht, wird das Gerät oder das Register automatisch erstellt.

Dazu verwenden wir den «_bulk_create» Endpunkt.

Dabei wird folgendes benötigt:

• deviceName
• registerName

Im Beispiel verwenden wir folgende Werte:

deviceName
: Zevvy Test Gerät Beispiel Ladestation
registerName
: Zevvy Test Register Beispiel Ladestation

Da das Gerät und das Register bislang nicht existieren, wird die API beide automatisch erstellen und die dazu gesendeten Daten importieren.

Nach dem Import können die Geräte sowie Register in Zevvy angeschaut und einem Messpunkt zugeteilt werden. (Siehe Video)

Code Beispiel
java python javascript shell php

Antwort
json
Inhalte werden geladen...
Inhalte werden geladen...
Inhalte werden geladen...
Inhalte werden geladen...
Inhalte werden geladen...
Inhalte werden geladen...

API Feedback

Wir schätzen Ihr Feedback, da es entscheidend für die Verbesserung unserer API und die Sicherstellung ist, dass sie Ihren Anforderungen entspricht. Ihre Einsichten helfen uns, Verbesserungsbereiche zu identifizieren und unsere zukünftige Entwicklung zu leiten. 

Vielen Dank, dass Sie sich einen Moment Zeit nehmen, um Ihre Erfahrungen mit uns zu teilen.

Wie einfach war es, unsere API in Ihr Projekt zu integrieren? 
Wie zufrieden sind Sie mit dem gebotenen Support?