Skip to main content

Domain hinzufügen und Benutzer zuweisen

Um einen neue Domain anzulegen und einem bestehenden Benutzer zuzuweisen, verwendet man den API-Endpunkt [POST] /domains. Über das Feld id_user bestimmen Sie, welchem Benutzer die Domain zugewiesen werden soll.

Über den Endpunkt [GET] /clients können zunächst alle vorhandenen Benutzer auf dem Server ermittelt werden. Die ID des gewünschten Benutzers verwenden Sie dann als Wert für das Feld id_user. Existiert noch kein Benutzeraccount, muss zunächst mindestens ein Benutzer angelegt werden.

Im Folgenden soll das Anlegen einer Domain example.com und das zuweisen dieser an einen Benutzer webhosting-001 demonstriert werden.


Benutzer auslesen

Über den API-Endpunkt [GET] /clients können alle im KeyHelp angelegten Benutzerkonten abgefragt werden.

Über den API-Endpunkt [GET] /clients/name/<NAME> können gezielt die Daten eines Benutzerkontos mit dem gewünschten Namen abgefragt werden, wie in der folgenden Abfrage verdeutlicht.


Anfrage
PHP 
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://<HOSTNAME>/api/v2/clients/name/webhosting-001');
curl_setopt($curl, CURLOPT_HTTPHEADER, [
  'X-API-KEY: <API-KEY>',
  'Content-Type: application/json',
]);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($curl);

Bash 
curl -X 'GET' \
  'https://<HOSTNAME>/api/v2/clients/name/webhosting-001' \
  -H 'accept: application/json' \
  -H 'X-API-Key: <API-KEY>'


Antwort

HTTP Status-Code: 200

{
    "id": 23,
    "username": "webhosting-001",
    ... 
}

Domain hinzufügen

Zum Anlegen einer Domain verwenden wir den Endpunkt [POST] /domains.
Aus der vorangegangen Abfrage der Konto-Vorlage übernehmen wir den Wert des Feldes id und geben ihn als Wert für das Feld id_user an. 
Als API-Antwort erhalten wir die ID der soeben hinzugefügten Domain.


Anfrage
PHP 
    $curl = curl_init();
    curl_setopt($curl, CURLOPT_URL, 'https://<HOSTNAME>/api/v2/domains');
    curl_setopt($curl, CURLOPT_HTTPHEADER, [
        'X-API-KEY: <API-KEY>',
        'Content-Type: application/json',
    ]);
    curl_setopt($curl, CURLOPT_POST, true);
    curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode([
        'domain' => 'example.com',
        'id_user' => 23,
    ]));
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
    $result = curl_exec($curl);

Bash 
curl -X 'POST' \
  'https://<HOSTNAME>/api/v2/domains' \
  -H 'accept: application/json' \
  -H 'X-API-Key: <API-KEY>' \
  -d '{ "domain": "example.com", "id_user": 23 }'


Antwort

HTTP Status-Code: 201

{
    "id": 193,
}

Back to top