API Funktionen

Aus mySCP Wiki
Wechseln zu: Navigation, Suche

Bitte beachten Sie das dass angesteuerte Webinterface das API Modul brauch, dieses gibt es derzeit bei uns als nicht Offizielles Modul zu erwerben bzw. als Erweiterung zu mieten. Von diesem benötigen Sie dann eine entsprechende Freigabe für die Kundennummer und ServerIP, ebenso bekommen Sie von diesem einen API-Key (Checkkey) und API-URL.

mySCP selbst verfügt bereits über eine entsprechende Integration, diese kleine Doku ist lediglich für den externen Zugriff gedacht.


NOCH IN ARBEIT!!!


API Ansteuern

XXX ist mit den entsprechenden Daten auszufüllen.
$config = array(
    'checkkey'  => 'XXX',
);

$data = array(
    'config'    => $config,
    'apikey'    => 'XXX',
    'modul'     => 'XXX',
    'mode'      => 'XXX',
    'func'      => 'XXX',
);

$postdata   = http_build_query($data);
$ch         = curl_init($APIURL);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postdata);
$response   = curl_exec($ch);
$response   = json_decode($response,true);
curl_close($ch);



API Voiceserver

Server anlegen

$config = array(
    'name'      => 'Teamspeak 3 Voiceserver',
    'slot'      => '10',
    'type'      => 'ts3',
);

$data = array(
    'config'    => $config,
    'apikey'    => 'XXX',
    'modul'     => 'voice',
    'mode'      => 'add',
    'func'      => ,
);


Server Reinstallieren

$config = array(
    'checkkey'  => 'XXX',
    'name'      => 'Teamspeak 3 Voiceserver',
);

$data = array(
    'config'    => $config,
    'apikey'    => 'XXX',
    'modul'     => 'voice',
    'mode'      => 'reinstall',
    'func'      => ,
);



Server Start / Stop / Restart

$config = array(
    'checkkey'  => 'XXX',
    'name'      => 'Teamspeak 3 Voiceserver',
);

$data = array(
    'config'    => $config,
    'apikey'    => 'XXX',
    'modul'     => 'voice',
    'mode'      => 'stastop',
    'func'      => 'start|stop|restart',
);


Token erstellen / löschen

FOLGT!


Backup erstellen / löschen / zurückspielen

FOLGT!


Server Informationen

$config = array(
    'name'      => 'Teamspeak 3 Voiceserver',
    'slot'      => '10',
    'type'      => 'ts3',
);

$data = array(
    'config'    => $config,
    'apikey'    => 'XXX',
    'modul'     => 'voice',
    'mode'      => 'status',
    'func'      => ,
);


Server bearbeiten

$config = array(
    'checkkey'           => 'XXX',
    'customer'           => 'XXX',
    'servername'         => 'XXX',
    'serverslot'         => '10',
    'serverpassword'     => 'XXX',
    'autostart'          => '1|0',
    'weblist_enabled'    => '1|0',
    'welcomemessage'     => 'XXX',
    'hostmessage'        => 'XXX',
    'hostmessage_mode'   => 'XXX',
    'welcomemessage'     => 'XXX',
    'hostbutton_tooltip' => 'XXX',
    'hostbutton_url'     => 'XXX',
    'hostbutton_gfx_url' => 'XXX',
    'hostbanner_url'     => 'XXX',
    'hostbanner_gfx_url' => 'XXX',
    'hostbanner_gfx_interval'=> '>60',
    'tsdns'              => 'sub.domain.de',
);
$data = array(
    'config'    => $config,
    'apikey'    => 'XXX',
    'modul'     => 'voice',
    'mode'      => 'edit',
    'func'      => 'edit',
);


API vServer

Server anlegen

$config = array(
    'servername'    => 'Ihr.Hostname.de',
    'serverpassword'=> 'XXX',
    'serverimage'   => 'XXX',
    'servercpu'     => '1',
    'serverhdd'     => '10',
    'servermemory'  => '1024',
    'serversmemory' => '512',
    'serverboot'    => '1',
    'type'          => 'lxc|kvm|ovz',
);

$data = array(
    'config'    => $config,
    'apikey'    => 'XXX',
    'modul'     => 'vserver',
    'mode'      => 'add',
    'func'      => ,
);
servername bitte unbedingt als Subdomain angeben.
serverimage wie diese im Webinterface einzusehen sind und auf dem Imageserver liegen, KVM mit .iso Endung, OVZ und LXC ohne Endung!
servercpu in Cores
serverhdd in GB
servermemory (RAM) & serversmemory (SWAP / Nur OVZ & LXC) in MB
serverboot = (1|0) ob vServer mit Systemstart hochgefahren werden soll.


Server Reinstallieren

$config = array(
    'password'  => 'XXX',
    'image'     => 'XXX',
);

$data = array(
    'config'    => $config,
    'apikey'    => 'XXX',
    'modul'     => 'vserver',
    'mode'      => 'install',
    'func'      => ,
);


Server Start / Stop / Restart

$config = array(
    'checkkey'  => 'XXX',
);

$data = array(
    'config'    => $config,
    'apikey'    => 'XXX',
    'modul'     => 'vserver',
    'func'      => 'start|stop|restart',
);


Server Informationen

$config = array(
    'checkkey'  => 'XXX',
);

$data = array(
    'config'    => $config,
    'apikey'    => 'XXX',
    'modul'     => 'vserver',
    'func'      => 'infos',
);