NiceAPI 1.0.23 w wersji PHP 5.6

Pozostając niezalogowanym posiadasz dostęp wyłącznie do ogólnej dokumentacji użycia oprogramowania. Zgłoś się do programu dla programistów, aby mieć dostęp do pełnej wersji dokumentacji dla developera.


Jak rozpocząć pracę z NiceAPI dla PHP 5.6 ?

Początek jak bardzo prosty. Jedyne co musisz zrobić to

  • Zdobyć odpowiednią wersję NiceAPI dla PHP 5.6 stąd niceapi.pl
  • Zainkludować w swoim projekcie Autoloader NiceAPI
  • Utworzyć nową instancję klasy Client (dla określonego namespace'u Dedicated lub Client) i zautoryzować swoje dane logowania
  • Korzystać ze wszystkich możliwości panelu Webas w swoim oprogramowaniu

Przykładowy kod

Nie zawijaj wierszy<?php

include_once("Kei/Autoloader.php");
// Jeśli posiadasz inne rozwiązanie serwerowe niż serwery dedykowane - skorzystaj z klasy \Kei\Webas\VPS\Client...
$webas = new \Kei\Webas\Dedicated\Client(12345);    // ...dla serwera linii dedykowanych
$webas->authenticate("login", "haslo");

if($webas->isAuthenticated())
{
    $info = $webas->Start()->Dashboard();
    // namespace \Kei\Library oferuje przydatne narzędzia do debugowania, wyświetlania itp
    \Kei\Library\Out::pd($info);
}

Klasa \Kei\Webas\Dedicated\Client oraz \Kei\Webas\VPS\Client przyjmuje nastepujące wartości

service_number

ID usługi (panelu Webas) jakim chcemy zarządzać. Poniżej zrzut ekranu gdzie można go odnaleźć

// Przykład: 12345

main_admin_panel
opcjonalny

Niestandardowy adres URL panelu Webas. Jeśli zmienialiśmy go w ustawieniach i mamy dla panelu przypiętą inną domenę.

// Domyślnie: NULL, Przykład: nasz-webas.example.com

is_https
opcjonalny

Jeśli Twój panel Webas nie działa z certyfikatem SSL ustaw wartość na false

// Domyślnie: true, Przykład: true

Zaloguj się do https://panel.kei.pl/, przejdź do zakładki usługi - tam odnajdziesz swoje serwery i numery ich usług.

Miejsce w którym zapisano ID usługi

Nazewnictwo klas i metod

Aby zapewnić maksymalną prostotę pracy z produktem NiceAPI nazwy poszczególnych klas i ich metod są zbieżne z adresem URL bezpośrednio w panelu Webas.

Na przykład adres https://webas12345.tld.pl/Domain/Add przekłada się na klasę Domain oraz metodę Add.

Nie zawijaj wierszy<?php

include_once("Kei/Autoloader.php");
// Jeśli posiadasz inne rozwiązanie serwerowe niż serwery dedykowane - skorzystaj z klasy \Kei\Webas\VPS\Client...
$webas = new \Kei\Webas\Dedicated\Client(12345);    // ...dla serwera linii dedykowanych
$webas->authenticate("login", "haslo");

if($webas->isAuthenticated())
{
    $res = $webas->Domain()->Add("test.example.com", 'default', "8k55HFBz6A")->
        execute()->             // Wykonaj...
        getActionResult();      // Opcjonalnie. Jaki rezultat dało wykonanie execute()

    \Kei\Library\Out::pd($res);
}

Dokładnie w taki sposób to działa w całym oprogramowaniu NiceAPI


Budowa i główna zasada działania oprogramowania

Intencją twórcy było stworzenie biblioteki, której można będzie używać w sposób łańcuchowy (ang. chaining method). Jest to jedna z najbardziej wydajnych metod używania tego typu oprogramowania w zewnętrznych projektach.

Obraz