REST-API¶

Voraussetzungen¶

Die REST-API ist ab LiveConfig 3.0 in allen Lizenzvarianten nutzbar. Auch „normale“ Benutzer (Endkunden) können die API nutzen, wenn die entsprechende Berechtigung im Hosting-Account gesetzt ist.

Authentisierung¶

Für den Zugriff auf die API müssen Sie zuerst einen API-Schlüssel erzeugen. Melden Sie sich hierzu im LiveConfig an und klicken dann rechts oben auf die Benutzereinstellungen. In der Box API können Sie über den Button Schlüssel erzeugen einen entsprechenden Schlüssel anlegen. Es wird dringend empfohlen, den Zugriff nur für einzelne IP-Adressen zu erlauben.

In späteren Versionen wird LiveConfig statt des symmetrischen API-Keys einen asymetrischen Schlüssel für JWT (JSON Web Token) unterstützen. Sie sollten die Authentifizierung für API-Zugrifft daher möglichst in eine separate Funktion auslagern, um diese später einfacher pflegen zu können.

Sie müssen bei allen REST-API-Zugriffen den API-Schlüssel über den HTTP-Header Authorization: Bearer <API-Key> mitschicken.

Beispiel¶

• adding a domain example.org to the account web77 of customer c0002:

  curl 'https://<server>:8443/liveconfig/api/v1/customers/c0002/domains' \
    -X POST
    -H 'Authorization: Bearer <API-Key>' \
    -H 'Accept: application/json' -H 'Accept-Language: en' \
    -H 'Content-Type: application/json' \
    --data-raw '{
      "domain": "example.org",
      "account": "web77",
      "www": true,
      "web": { "enabled": true, "type": "webspace", "target": "/" },
      "mail": { "enabled": true, "dkim": true }
    }'
  

API-Methoden¶

Eine vollständige Dokumentation aller verfügbaren API-Methoden finden Sie

• im LiveConfig unter den Benutzereinstellungen (Box API, Button API-Dokumentation)

• in der Wissensdatenbank

Sie können mit einem API-Key die Funktionen auch direkt aus der Dokumentation heraus testen.