DCP-API: Unterschied zwischen den Versionen
Rb (Diskussion | Beiträge) |
Rb (Diskussion | Beiträge) |
||
(12 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
Zeile 7: | Zeile 7: | ||
[[Datei:Apipasswort.png]] | [[Datei:Apipasswort.png]] | ||
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. | 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. | ||
[[Datei:Apiuserlogin.png]] | |||
==Übersicht der angebotenen Funktionen== | ==Übersicht der angebotenen Funktionen== | ||
Zeile 13: | Zeile 14: | ||
[[datei:Api übersicht.png]] | [[datei:Api übersicht.png]] | ||
===database=== | ===database=== | ||
[[Datei:Databaseapi.png]] | |||
===dcpuser=== | ===dcpuser=== | ||
[[Datei:Apidcpuser.png]] | |||
===dns=== | ===dns=== | ||
[[Datei:DCP-API-DNS.png|DCP-API-DNS]] | [[Datei:DCP-API-DNS.png|DCP-API-DNS]] | ||
===domain=== | ===domain=== | ||
[[Datei:Domainapi.png]] | |||
===info=== | ===info=== | ||
[[Datei:Infoapi.png]] | |||
===mail=== | ===mail=== | ||
[[Datei:Mailapi.png]] | |||
===stats=== | ===stats=== | ||
[[Datei:Statsapi.png]] | |||
===web=== | ===web=== | ||
[[Datei:Webapi.png]] | |||
==Beispiel aus der Kategorie Web== | ==Beispiel aus der Kategorie Web== | ||
Zeile 43: | Zeile 45: | ||
$type=$_POST['type']; | $type=$_POST['type']; | ||
$local_dir=$_POST['local_dir']; | $local_dir=$_POST['local_dir']; | ||
$url="https://IHRAPIACCOUNT: | $url="https://IHRAPIACCOUNT:IHRAPIPASSWORT@IHRSERVER.c.artfiles.de/api/web/ | ||
add_subdomain.html?fqdn=$fqdn&type=$typel&local_dir=$local_dir" | add_subdomain.html?fqdn=$fqdn&type=$typel&local_dir=$local_dir" | ||
$result = file_get_contents($url); | $result = file_get_contents($url); | ||
Zeile 55: | Zeile 57: | ||
== Weitere Beispiele zur Verwendung == | == Weitere Beispiele zur Verwendung == | ||
<div style="border:1px solid #808080; margin:5px 3px 0px 3px; padding:0 5px 2px 5px; background:#EEEEEE">'''Hinweis''': Ersetzen Sie <span style="color: blue; font-weight: bold;">IHRAPIACCOUNT</span> durch Ihren API-Benutzernamen (Format: apiXXXXX), <span style="color: red; font-weight: bold;">IHRAPIPASSWORT</span> durch Ihr gesetztes API-Passwort und <span style="color: green; font-weight: bold;">IHRSERVER</span> durch die entsprechende Servernummer (Format: dcpXXXX). Infos zu den '''Parametern''' können oben in den einzelnen Erläuterungen zu den API-Funktionen eingesehen werden. </div> | |||
'''Anlegen einer neuen Datenbank:''' | '''Anlegen einer neuen [[DCP-API#database|Datenbank]]:''' | ||
<div style="white-space: pre; font-family: monospace; line-height: 0.8; font-size: 14px; background-color: #EEEEEE; border: 1px solid #808080; margin:5px 3px 0px 3px; padding:0 5px 2px 5px; display: block; overflow: auto;"> | <div style="white-space: pre; font-family: monospace; line-height: 0.8; font-size: 14px; background-color: #EEEEEE; border: 1px solid #808080; margin:5px 3px 0px 3px; padding:0 5px 2px 5px; display: block; overflow: auto;"> | ||
https://<span style="color:blue; font-weight:bold;">IHRAPIACCOUNT</span>:<span style="color:red; font-weight:bold;">IHRAPIPASSWORT</span>@<span style="color:green; font-weight:bold;">IHRSERVER</span>.c.artfiles.de/api/database/add_database.html?type=mysql&pass=dbpasswd | https://<span style="color:blue; font-weight:bold;">IHRAPIACCOUNT</span>:<span style="color:red; font-weight:bold;">IHRAPIPASSWORT</span>@<span style="color:green; font-weight:bold;">IHRSERVER</span>.c.artfiles.de/api/database/add_database.html?type=mysql&pass=dbpasswd | ||
</div> | </div> | ||
'''Liste aller DCP-User ausgeben:''' | '''Liste aller [[DCP-API#dcpuser|DCP-User]] ausgeben:''' | ||
<div style="white-space: pre; font-family: monospace; line-height: 0.8; font-size: 14px; background-color: #EEEEEE; border: 1px solid #808080; margin:5px 3px 0px 3px; padding:0 5px 2px 5px; display: block; overflow: auto;"> | <div style="white-space: pre; font-family: monospace; line-height: 0.8; font-size: 14px; background-color: #EEEEEE; border: 1px solid #808080; margin:5px 3px 0px 3px; padding:0 5px 2px 5px; display: block; overflow: auto;"> | ||
https://<span style="color:blue; font-weight:bold;">IHRAPIACCOUNT</span>:<span style="color:red; font-weight:bold;">IHRAPIPASSWORT</span>@<span style="color:green; font-weight:bold;">IHRSERVER</span>.c.artfiles.de/api/dcpuser/get_dcpuser.html | https://<span style="color:blue; font-weight:bold;">IHRAPIACCOUNT</span>:<span style="color:red; font-weight:bold;">IHRAPIPASSWORT</span>@<span style="color:green; font-weight:bold;">IHRSERVER</span>.c.artfiles.de/api/dcpuser/get_dcpuser.html | ||
</div> | </div> | ||
'''Liste aller Domains eines DCP-Users ausgeben:''' | '''Liste aller [[DCP-API#domain|Domains]] eines DCP-Users ausgeben:''' | ||
<div style="white-space: pre; font-family: monospace; line-height: 0.8; font-size: 14px; background-color: #EEEEEE; border: 1px solid #808080; margin:5px 3px 0px 3px; padding:0 5px 2px 5px; display: block; overflow: auto;"> | <div style="white-space: pre; font-family: monospace; line-height: 0.8; font-size: 14px; background-color: #EEEEEE; border: 1px solid #808080; margin:5px 3px 0px 3px; padding:0 5px 2px 5px; display: block; overflow: auto;"> | ||
https://<span style="color:blue; font-weight:bold;">IHRAPIACCOUNT</span>:<span style="color:red; font-weight:bold;">IHRAPIPASSWORT</span>@<span style="color:green; font-weight:bold;">IHRSERVER</span>.c.artfiles.de/api/domain/get_domains.html?dcpuser=dcp12340001 | https://<span style="color:blue; font-weight:bold;">IHRAPIACCOUNT</span>:<span style="color:red; font-weight:bold;">IHRAPIPASSWORT</span>@<span style="color:green; font-weight:bold;">IHRSERVER</span>.c.artfiles.de/api/domain/get_domains.html?dcpuser=dcp12340001 | ||
</div> | </div> | ||
'''Ändern eines Passwortes für einen Mailaccount:''' | '''Ändern eines Passwortes für einen [[DCP-API#mail|Mailaccount]]:''' | ||
<div style="white-space: pre; font-family: monospace; line-height: 1; font-size: 14px; background-color: #EEEEEE; border: 1px solid #808080; margin:5px 3px 0px 3px; padding:0 5px 2px 5px; display: block; overflow: auto;"> | <div style="white-space: pre; font-family: monospace; line-height: 1; font-size: 14px; background-color: #EEEEEE; border: 1px solid #808080; margin:5px 3px 0px 3px; padding:0 5px 2px 5px; display: block; overflow: auto;"> | ||
https://<span style="color:blue; font-weight:bold;">IHRAPIACCOUNT</span>:<span style="color:red; font-weight:bold;">IHRAPIPASSWORT</span>@<span style="color:green; font-weight:bold;">IHRSERVER</span>.c.artfiles.de/api/mail/set_password.html?account=mail@domain.de&password=passwd | https://<span style="color:blue; font-weight:bold;">IHRAPIACCOUNT</span>:<span style="color:red; font-weight:bold;">IHRAPIPASSWORT</span>@<span style="color:green; font-weight:bold;">IHRSERVER</span>.c.artfiles.de/api/mail/set_password.html?account=mail@domain.de&password=passwd | ||
</div> | </div> |
Aktuelle Version vom 12. März 2025, 17:41 Uhr
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
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
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