MikroBILL - Микро биллинг для MikroTik и не только

API для PHP и Python

API для .NET

Написанное ниже относится к версиям MikroBILL 2.0.6 и более новым. Для создания расширений на PHP вам понадобится подключить файл apicore.php (найти его можно в папке WEB документов апача в подпапке kassa). Полное описание классов доступно здесь. Версия класса для Python здесь.
1. Пример на PHP для подключения к серверу MikroBILL. // Импортируем библиотеку API include 'apicore.php'; // Создаём новый экземпляр класса MikroBILL_API $Api = new MikroBILL_API('IP_или_host', Port, 'Login', 'Password'); // Выполняем запрос API $Api->Process('Команда API'); // Закрываем соединение $Api->Close(); Вы можете скопировать файл apicore.php на другой WEB-сервер, где нет кассы MikroBILL, тогда при создании экземпляра класса MikroBILL_API необходимо добавить ещё 2 аргумента: // Создаём новый экземпляр класса MikroBILL_API $Api = new MikroBILL_API('IP_или_host', Port, 'Login', 'Password', $CRYPTO_KEY_1, $CRYPTO_KEY_2); Переменную $CRYPTO_KEY_1 вы можете взять из файла config.php, который расположен в корне WEB сервера MikroBILL, а переменную $CRYPTO_KEY_2 из БД MikroBILL из таблицы `workparams`. Обратите внимание, что значения этих переменных являются уникальными и при переустановке MikroBILL будут изменены!
2. Формат команд. Команды вызываются по их пути. Разделителем пути является символ точки. Путь соответсвует классам в их иерархии, описание классов доступно здесь. Как видим, команда получения или поиска абонентов находится непосредственно в классе API, значит вызов будет выглядеть так: $Api->Process('API.GetClients'); Результатом будет JSON вида: {"return":[...], "code":0} В поле return массив ID абонентов. Поле code = 0 показывает отсутствие ошибок. Любое другое число сигнализирует о проблеме, тогда в return будет описание. Чтобы обратиться к свойству абонента, в пути команды необходимо указать ID абонета: // Получаем имя абонента $Api->Process("API.Client.$ClientGUID.AutorizeInfo.Name"); Результат: {"return":"UserName", "code":0} Ещё пример. Установим новый IP абоненту. Для этого нужно вначале получить все аккаунты абонента: $Api->Process("API.Client.$ClientGUID.AutorizeInfo.Accounts"); Результатом будет массив GUID аккаунтов: {"return":[...], "code":0} Теперь обратимся к нужному аккаунту, чтобы получить свойство "IP". $Api->Process("API.Client.$ClientGUID.AutorizeInfo.Accounts.$AccountGUID.IP"); Ответ: {"return":"IP_клиента", "code":0} Для установки значения необходимо добавить второй аргумент в функцию Process: $Api->Process("API.Client.$ClientGUID.AutorizeInfo.Accounts.$AccountGUID.IP", "192.168.10.25"); Если функция требует несколько входящих аргументов, то их нужно передавать в виде массива. Напоминаем, описание входных аргументов Вы можете найти в описании классов здесь. // Добавляем аккаунт абоненту $Api->Process("API.Client.$ClientGUID.AutorizeInfo.Accounts.AddAccount",["120.10.53.234","","Login","Password"]); Если операция прошла успешно, вы получит сообщение вида: {"return":"OK", "code":0} 3. Пакетные команды. Вы можете в одной команде запрашивать несколько значений (начиная с версии MikroBILL 2.0.9), для этого во второй аргумент в функцию Process необходимо передать массив. В массиве необходимо перечислить аргументы так, чтобы начальный путь в функции Process + имя элемента массива образовали законченный путь. // Создаём массив и перечисляем аргументы. $arr = array((string)$AccountGUID => array('IP', 'MAC')); // Выполняем команду $Api->Process("API.Client.$ClientGUID.AutorizeInfo.Accounts", $arr); // В данном случае будут вызваны 2 пути: // API.Client.$ClientGUID.AutorizeInfo.Accounts.$AccountGUID.IP // API.Client.$ClientGUID.AutorizeInfo.Accounts.$AccountGUID.MAC Результатом будет JSON вида: [{"return":"1.1.1.1", "code":0, "path":"API.Client.6338241.AutorizeInfo.Accounts.28236.IP"}, {"return":"AA:AA:AA:AA:AA:AA", "code":0, "path":"API.Client.6338241.AutorizeInfo.Accounts.28236.MAC"}, {"object":{"Client":{"6338241":{"AutorizeInfo":{"Accounts":{"28236":{"IP":"1.1.1.1","MAC":"AA:AA:AA:AA:AA:AA"}}}}}}}] Начиная с версии MikroBILL 2.0.15 в ответ добавлен параметр "object", возвращающий результат всего запроса в виде JSON объекта. Для того, чтобы установить несколько параметров одновременно, нужно в массиве к каждому аргументу добавить ассоциированное значение. // Создаём массив и перечисляем аргументы. $arr = array((string)$AccountGUID => array('IP' => '192.168.25.110', 'MAC' => 'aa:bb:cc:dd:ee:ff')); // Выполняем команду $Api->Process("API.Client.$ClientGUID.AutorizeInfo.Accounts", $arr); Результатом будет JSON вида: [{"return":"OK", "code":0, "path":"API.Client.6338241.AutorizeInfo.Accounts.28236.IP"}, {"return":"OK", "code":0, "path":"API.Client.6338241.AutorizeInfo.Accounts.28236.MAC"}] Так же имеется возможность в одной команде читать параметры и устанавливать. // Создаём массив и перечисляем аргументы. $arr = array((string)"$ClientGUID.BillingInfo.Money", (string)"$ClientGUID2.AutorizeInfo.Accounts.$AccountGUID2" => array('MAC' => 'aa:bb:cc:dd:ee:ff')); // Выполняем команду $Api->Process("API.Client", $arr); Результатом будет JSON вида: [{"return":"100.01", "code":0, "path":"API.Client.6338241.BillingInfo.Money"}, {"return":"OK", "code":0, "path":"API.Client.6338241.AutorizeInfo.Accounts.28236.MAC"}] Вы можете использовать массивы с любой глубиной вложенности. Например, здесь: // Создаём массив и перечисляем аргументы. $arr=array('IP' => '192.168.25.110'); // Выполняем команду $Api->Process("API.Client.6338241.AutorizeInfo.Accounts.28236", $arr); И здесь: // Создаём массив и перечисляем аргументы. $arr = array('AutorizeInfo' => array('Accounts' => array('28236' => array('IP' => '192.168.25.110')))); // Выполняем команду $Api->Process("API.Client.6338241", $arr); В обоих случаях вызывается путь: API.Client.6338241586374.AutorizeInfo.Accounts.28236.IP 4. Поиск данных. Начиная с версии MikroBILL 2.0.14 доступен поиск данных, для этого используется оператор Find, который присутствует внутри всех базовых классов. Поиск возращает GUID объектов, имеющих в своих полях искомые данные. Команда поиска выглядит следующим образом: $Api->Process("API.Класс.Find", ['Путь', 'Оператор_сравнения', Сравниваемое_значение]); Например: // Выполняем команду поиска $Api->Process("API.Client.Find", ['StatusInfo.BlockReason', '=', -1]); Вторым аргументом в функцию Process передаётся массив. Первый аргрумент массива - это путь, значение которого, мы будем сравнивать с условием. Второй аргумент - математическое условие. Третий аргумент - значение, с которым сравниваем. Т.е. в нашем примере функция вернёт GUID всех абонентов, у которых StatusInfo.BlockReason = -1, т.е. всех, кому разрешён доступ. Более подробная информация на странице описания классов. Вы можете использовать несколько условий поиска. Для этого в массив четвёртым аргуметом добавьте AND или OR, а последующие три аргумента должны быть идентичны по своей сути первым трём, т.е. это: путь, логика сравнения и сравниваемое значение. Количество дополнительных условий отбора может быть любым. В примере ниже ищем GUID абонентов, которым разрешё доступ и у которых IP соответствует маске: // Выполняем команду поиска $Api->Process('API.Client.Find',['AutorizeInfo.Accounts..IP','LIKE','10.32.','AND','StatusInfo.BlockReason','=',-1]); Как видим из примера выше, можно искать внутри любых печислений, например, в списке аккаунтов. Для этого в пути вместо GUID элемента нужно ставить символ .