README

通过API与4box系统通信

API访问仅限于Operor的需求，为此，需要向NaszaWizja申请分配访问权限。用于通信的系统需求

• 分配给4BOX API模块的平台登录名和密码
• 禁用支付模块 - 验证计费。启用支付模块 - 可选添加优惠券。
• 在运营商系统和4BOX平台上的外部代码订阅名称一致
• 运营商系统中的用户名与4BOX平台侧的用户名一致

在启动API之前，为正确进行API通信而创建的用户应在系统内添加前缀。如果运营商的代码是99，则其所有用户都应具有前缀“99-”（即九十九减号）接着是运营商系统ID - 完整的用户名显示 -> 99-00123 或 99-stefan.jakis等。

安装

通过composer下载并安装库

composer require xsme/php-hibox-api

功能

所有功能的列表及其描述和返回值。

// $location - uzyskujemy z NaszaWizja
// $username - uzyskujemy z NaszaWizja
// $password - uzyskujemy z NaszaWizja
$hibox = new Hibox($location, $username, $password)

// Pobieranie ustawień ISP z systemu Hibox.
$test = $hibox->getSystemSettings();

// Pobieranie wszystkich metod płatności.
$test = $hibox->getSystemPaymentMethods();

// Pobieranie danych o uzytwkoniku według jego identyfikatora.
$test = $hibox->getCustomerByName(1234);

// Pobieranie wszystkich uzytkowników naleacych do ISP.
$test = $hibox->getCustomerAll();

// Pobieranie listy wszystkich subskrypcji dla uzytkownika.
$test = $hibox->getCustomerPurchases(
    1234,
    '2020-09-30T23:59:59.999',
    '2020-09-30T23:59:59.999',
    'PLN'
);

// Pobieranie listy aktywnych subskrypcji dla uztkownika.
$test = $hibox->getCustomerActivePurchases(1234, 'PLN');

// Pobieranie dodatkowych informacji o uzytkowniku.
// PIN do zakupow, PIN do kontroli rodzicielskiej.
$test = $hibox->getCustomerRights(1234);

// Dodawanie nowego uzytkownika do systemu.
$test = $hibox->postCustomerCreate();

// Usuwanie uzytkownika z systemu Hibox.
$test = $hibox->postCustomerDelete();

// Zmiana kodu PIN uzytkownika do weryfikowania zakupów.
// To nie jest kod PIN do kontroli rodzicielskiej.
$test = $hibox->postCustomerUpdatePinCode();

// Zmiana kodu PIN do kontroli rodzicielskiej.
$test = $hibox->postCustomerUpdateLockCode();

// Zmiana hasła do autoryzacji uzytkownika na STB w systemie.
$test = $hibox->postCustomerUpdatePassword();

// Pobieranie wszystkich subskrypcji.
$test = $hibox->getSubscriptionAll();

// Pobieranie listy wszystkich subskrypcji zakupionych/aktywowanych pomiedzy datami.
$test = $hibox->getSubscriptionPurchasedBetween();

// Anulowanie subskrypcji uzytkownika na koniec okresu rozliczeniowego.
// Aby pobrać $serviceId, trzeba najpierw wywołać listę aktywnych usług na uzytwkoniku,
// nastepnie podać id usługi np. 2307058, data zakończenai jest na ostatni dzień miesiąca.
$test = $hibox->postSubscriptionCancel();

// Anulowanie subskrypcji uzytkownika natychmiastowo.
$test = $hibox->postSubscriptionCancelForced();

// Tworzenie nowej subskrypcji dla uzytkownika.
$test = $hibox->postSubscriptionCreate();

// Pobiera listę urzadzeń (stb) przypisanch do uzytkownika (klienta).
$test = $hibox->getDevicesAssignedToClient();

// Dodawanie nowego urządzenia i przypisanie go do uzytkownika.
$test = $hibox->postDeviceCreate();

// Usuwanie urządzenia lub kilku od wybranego uzytkownika (klienta).
$test = $hibox->postDeviceDelete();