DCP-API

DCP-Api allgemein

Mit unseren Web-APIs (Application Programming Interface) bieten wir Ihnen die Möglichkeit, Funktionen im DCP mit Ihren eigenen Skripten zu automatisieren. Um unsere APIs nutzen zu können, vergeben Sie im DCP unter 'Passwörter' (1) für Ihren API-Benutzer ein neues Passwort (2) und setzen den Nutzer auf aktiv.

Mit dem API-Benutzer und dem vergebenen Passwort können Sie sich dann ins DCP einloggen, um eine Übersicht der vorhandenen APIs zu bekommen. Hierfür müssen Sie sich zuvor aber aus dem DCP mit dem Logout-Button ausloggen und mit Ihren API-Zugangsdaten schließlich im Loginbereich anmelden.

Übersicht der angebotenen Funktionen

database

dcpuser

dns

domain

info

mail

stats

web

Beispiel aus der Kategorie Web

In diesem Fall wird die Subdomain 'neu.domain.de' als lokale Domain mit dem Homeverzeichnis 'domain.de/www' angelegt. Dazu werden folgende Parameter benötigt:

• fqdn=neu.domain.de - vollständiger Name der neuen Subdomain
• type=local - Typ der neuen Subdomain
• local_dir=domain.de/www - Homeverzeichnis der neuen Subdomain

Angenommen diese Informationen werden über ein HTML-Formular per POST an ein PHP-Skript übergeben, könnte der PHP-Code folgendermaßen aussehen:

   <?php
   $fqdn=$_POST['fqdn'];
   $type=$_POST['type'];
   $local_dir=$_POST['local_dir'];
   $url="https://IHRAPIACCOUNT:IHRAPIPASSWORT@IHRSERVER.c.artfiles.de/api/web/
   add_subdomain.html?fqdn=$fqdn&type=$typel&local_dir=$local_dir"
   $result = file_get_contents($url);
   echo $result;
   ?>

Als Ergebnis wird "OK" zurückgegeben, wenn die Subdomain erfolgreich angelegt wurde. Ansonsten wird als Ergebnis "ERROR" zurückgegeben.

Auf gleiche Weise können unter anderem Subdomains, Mailaccounts, Datenbanken erstellt, geändert oder gelöscht werden. Eine Übersicht der verwendeten Parameter und Ausgaben der APIs finden Sie im DCP. Bitte beachten Sie, dass die DCP-API nur per HTTPS erreichbar ist.

Weitere Beispiele zur Verwendung

Anlegen einer neuen Datenbank:

https://IHRAPIACCOUNT:IHRAPIPASSWORT@IHRSERVER.c.artfiles.de/api/database/add_database.html?type=mysql&pass=dbpasswd

Ersetzen Sie IHRAPIACCOUNT durch Ihren API-Benutzernamen (Format: apiXXXXX), IHRAPIPASSWORT durch Ihr gesetztes API-Passwort und IHRSERVER durch die entsprechende Servernummer (Format: dcpXXXX).

Liste aller DCP-User ausgeben:

https://IHRAPIACCOUNT:IHRAPIPASSWORT@IHRSERVER.c.artfiles.de/api/dcpuser/get_dcpuser.html

Liste aller Domains eines DCP-Users ausgeben:

https://IHRAPIACCOUNT:IHRAPIPASSWORT@IHRSERVER.c.artfiles.de/api/domain/get_domains.html?dcpuser=dcp12340001

Ändern eines Passwortes für einen Mailaccount:

https://IHRAPIACCOUNT:IHRAPIPASSWORT@IHRSERVER.c.artfiles.de/api/mail/set_password.html?account=mail@domain.de&password=passwd