Artfiles GmbH
Artfiles GmbH
headillu

DCP-API

1. 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' für Ihren API-Benutzer ein neues Passwort 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:

2. Übersicht der angebotenen Funktionen

  1. database
    Hier finden Sie Scripte zum Anlegen neuer Datenbanken sowie zum Anzeigen und Löschen bestehender Datenbanken.
  2. dcpuser
    Wir bieten Ihnen hier ein Script zum Anzeigen der DCP-User an.
  3. dns
    Derzeit stehen keine Scripte für diesen Bereich zur Verfügung.
  4. domain
    Derzeit steht ein Script zur Verfügung, das alle in Ihrem Webhosting Account befindlichen Domains mit Abrechnungsdatum anzeigt, sowie, falls vorhanden, ihre Zuordnung zu Ihrem DCP-User zu.
  5. info
    Es ist ein Script vorhanden, um Accountdaten, wie vorhandener und verbrauchter Webspace, auszugeben.
  6. mail
    Alles, was mit Mailfunktionen zu tun hat, finden Sie hier. Derzeit können Sie Passwörter für einen Mailaccount prüfen und ändern sowie die angelegten Mailaccounts anzeigen lassen.
  7. stats
    In diesem Bereich finden Sie Scripte um Statistiken aus dem DCP abzurufen.
  8. web
    In diesem Bereich finden Sie Scripte, um eine Subdomain anzulegen, zu löschen und zum Anzeigen der vorhandenen Subdomains sowie zur Bearbeitung Ihrer FTP-User.

3. 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://api1234:passwd@dcp20.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.

    4. Weitere Beispiele zur Verwendung

    1. Anlegen einer neuen Datenbank:
      https://api1234:passwd@dcp20.c.artfiles.de/api/database/add_database.html?type=mysql&pass=dbpasswd
    2. Liste aller DCP-User ausgeben:
      https://api1234:passwd@dcp20.c.artfiles.de/api/dcpuser/get_dcpuser.html
    3. Liste aller Domains eines DCP-Users ausgeben:
      https://api1234:passwd@dcp20.c.artfiles.de/api/domain/get_domains.html?dcpuser=dcp12340001
    4. Ändern eines Passwortes für einen Mailaccount:
      https://api1234:passwd@dcp20.c.artfiles.de/api/mail/set_password.html?account=mail@domain.de&password=passwd
facebook twitter
Share this page on twitter facebook delicious email
* Wenn nicht anders angegeben, verstehen sich alle Preisangaben inklusive der gesetzlichen Mehrwertsteuer.
Valid HTML 4.01 Strict