API funkce pro Stable

Application Programming Interface - API je rozhraním pro programování aplikací. Funkce API jsou programové celky, které programátor používá místo toho, aby je sám naprogramoval. API je abstrakce, která definuje a popisuje rozhraní pro interakci s řadou funkcí, používaných součástí softwarového systému.

Jak použít Stable API?

Pro použití našeho API budete od nás potřebovat API klíč, který je k nalezení na stránce (musíte být přihlášení do webadminu) -> webadmin.stable.cz/api/

Po získání API klíče se budete moci k našemu API připojit a to následovně:

$login = array('user' => 'vas_login_do_administrace', 'apiKey' => 'vas_api_klic_vypada_nasledovne_595d0f867615805dbc9e0a39b23612151f59176');

$options = array(
'uri' => 'urn://webadmin.stable.cz',
'location' => 'https://webadmin.stable.cz/api.php',
'trace' => 1,
'exceptions' => 0
);

$client = new SoapClient(null, $options);

Po takovémto napojení se na API můžete používat funkce.

Seznam funkcí:

• Výpis e-mailových schránek:
  
  emailList($login, 'nazev-domeny.TLD');
  
  
• Tvorba nové e-mailové schránky:
  
  createEmail($login, 'nazev-nove-schranky@domena.TLD', 'heslo');
  
  
• Změna hesla e-mailové schránky:
  
  changePassword($login, 'nazev-nove-schranky@domena.TLD', 'nove-heslo');
  
  
• Smazání e-mailové schránky:
  
  deleteEmail($login, 'nazev-nove-schranky@domena.TLD');
  
  
• Vypsání domén (včetně expirace, IP adresy, serveru)
  
  domainList($login);
  
  
• Vytvoření domény
  
  $params['variant'] = 'standard';
  $domains = $client->createDomain($login, 'novadomena.cz', $params);
  
  
• Vytvoření mysql uživatele
  
  ->createMysqlUser($login, $mysqlUser, $mysqlPassword, $mysqlIp)
  
  
• Smazání mysql uživatele
  
  ->deleteMysqlUser($login, $mysqlUser, $mysqlIp)
  
  
• Vytvoření databáze
  
  ->createMysqlDb($login, $dbName)
  
  
• Mazání databáze
  
  ->deleteMysqlDb($login, $dbName)
  
  
• Přidání přístupu mysql uživatele k DB
  
  ->addMysqlAccess($login, $mysqlUser, $mysqlUserIp, $db
  
  
• Odebrání přístupu mysql uživatele k DB
  
  ->removeMysqlAccess($login, $mysqlUser, $mysqlUserIp, $db);
  
  

Příklad použití API:

Chci vytvořit novou emailovou schránku u domény domena.cz a schránka má vypadat jako fakturace@domena.cz

Vytvořím si script, který bude vypadat takto:

<?php

$login = array('user' => 'nazevuzivatele', 'apiKey' => '595d8f86761405dbc9e0a39b2379612151f59116');

$options = array(
'uri' => 'urn://webadmin.stable.cz',
'location' => 'https://webadmin.stable.cz/api.php',
'trace' => 1,
'exceptions' => 0
);

$client = new SoapClient(null, $options);

$client->createEmail($login, 'fakturace@domena.cz', 'heslo15698742');

?>


Výstup
Hodnota vrací status a message s informací, zda se povedlo či nepovedlo vytvořit schránku.

array(2) { ["status"]=> string(2) "ok" ["message"]=> string(36) "E-mail has been successfully created" }