Wir arbeiten an einer neuen Version unserer API. Aber auch die derzeitige Version ist für Dich verfügbar. Daher ist dies ein guter Zeitpunkt, Dir unsere derzeitige API einmal kurz vorzustellen.

Nach dem Release der neuen Version werden wir Dir diese – bzw. die Neuerungen – ebenfalls erläutern.

 

Was ist eine API?

Die Abkürzung API steht für Application Programming Interface, auf Deutsch auch Programmier- oder Anwendungsschnittstelle. Häufig wird in diesem Zusammenhang auch von Services gesprochen.

Mithilfe einer API kannst Du bei einem entfernten System z.B.

  • Daten abfragen
  • Daten schreiben oder löschen
  • Funktionen aufrufen

Schon seit vielen Jahren sind APIs oder Services weit verbreitet und werden häufig genutzt, um Dritten zu erlauben, verschiedene Systeme aneinander anzuschließen.

 

Und was ist mit der Server-Eye API?

Wir bieten schon lange eine API an, damit Du Deine Systeme mit Server-Eye verbinden kannst. Diese haben wir kürzlich erweitert und verbessert.

Ein guter Anlass, Dir unsere API einmal vorzustellen!

 

Grundlagen

Die Server-Eye-API basiert auf REST (Representational State Transfer), einem Paradigma für die Kommunikation von Systemen. Für die Datenübertragung wird das leichtgewichtige und einfach zu lesende JSON (JavaScript Object Notation) genutzt.

Mit anderen Worten: unsere API nutzt die gleichen Technologien wie andere aktuelle Services und kann somit leicht mit Deinen Systemen verbunden werden.

Um sich gegen unsere Schnittstelle zu authentifizieren, ist entweder eine Nutzer-/Passwortkombination oder ein API-Key erforderlich. Der Zweitgenannte kann im OCC von Dir für die einzelnen Kunden erstellt werden, d.h. Du kannst eigene Zugänge je nach Kunden haben.

Die API ist unter https://api.server-eye.de/docs/2/#/main erreichbar. Dort findest Du auch weitere Informationen über die Möglichkeiten, die sich Dir bieten sowie welche Struktur und Daten für die Zugriffe erforderlich sind.

Im Folgenden werden wir Dir einige Beispiele zeigen. Für die Zugriffe nutzen wir dabei die weitverbreitete Software Postman.

 

Beispiele

Login in den Service mit Benutzerdaten (eigene E-Mail und Passwort)

 

Nach einem erfolgreichen Login kommt ein entsprechender Statuscode (200) und ein Objekt mit Informationen über den aktuellen User zurück:

 

Nun können die Daten aller Kunden mit einem GET auf https://api.server-eye.de/2/customer geholt werden:

 

Die „cId“ aus der vorherigen Antwort ist der Kenner für die Abfrage der Daten eines einzelnen Kunden: https://api.server-eye.de/2/customer/aaabbbccc12312323dddeee

 

Fazit

Du siehst also, die Nutzung der Server-Eye-API ist einfach und fast schon selbsterklärend. Mit den Informationen aus diesem Artikel und den Daten von https://api.server-eye.de/docs/2/#/main kannst Du direkt mit einem eigenen Projekt starten!

4.8/5 - (31 votes)