Grundlagen der Kommunikation, Authentifizierung

URL und Antwortformat

Die API-Schnittstelle ist unter folgender Adresse verfügbar:

https://api.wedos.as/partner/{nazev_metody}

Anhand der requestId können wir im Falle eines Problems die konkrete Kommunikation in den internen Protokollen nachverfolgen.

Authentifizierung

Jede API-Anfrage muss authentifiziert werden. Dazu dient der API-Schlüssel, der ähnlich wie ein Passwort funktioniert, jedoch ausschließlich für die API bestimmt ist.
Der API-Schlüssel ist nicht identisch mit dem Passwort, das Sie für die Anmeldung in der Partnerverwaltung verwenden.

HTTP-Header

Die Authentifizierung erfolgt über zwei HTTP-Header, die jeder Anfrage hinzugefügt werden müssen:

• X-Auth-Id – API-Schlüssel-ID
• X-Auth-Key – der API-Schlüssel selbst

Beispiel für eine HTTPS-Anfrage

Nachfolgend finden Sie ein Beispiel für eine einfache API-Anfrage einschließlich der erforderlichen HTTP-Header.
Es handelt sich um eine Ping-Methode, mit der Sie überprüfen können, ob die Kommunikation ordnungsgemäß funktioniert.

GET /partner/ping HTTP/1.1
Host: api.wedos.as
Accept: application/json
X-Auth-Id: IDKLICE
X-Auth-Key: VASKLIC

Beispielantwort

Bei erfolgreichem Aufruf der Ping-Methode gibt die API die Partner-ID sowie das aktuelle Datum und die aktuelle Uhrzeit zurück:

{
  "stamp": 1495544024,
  "time": "2017-05-23 14:53:44",
  "partnerId": 300000,
  "requestId": "1495544024.0084.8420"
}

Fehlerhafte Antworten

Im Falle eines Fehlers gibt der Server einen HTTP-Code ungleich 200 zurück, und im Antworttext werden der Fehlercode und dessen Beschreibung angegeben.
Beispielsweise bei einer Anfrage mit fehlerhafter Authentifizierung:

{
  "error": {
    "code": "C507",
    "error": "Authentication failed"
  },
  "requestId": "1495544185.1615.8422"
}