finbox/sdk

Finbox API SDK

v1.0.1 2022-05-05 16:07 UTC

Requires

• php: >=7.0
• ext-curl: *
• ext-json: *

Requires (Dev)

• mockery/mockery: *
• phpunit/phpunit: ^6.5.14

mit

• Alexander Kiselev

README

Класс Finbox

| Основной интерфейс работы с системой Finbox.

Параметры

Название	Тип	Описание	Обязательное
{TOKEN}	string	Ключ доступа	да
{SECRET}	string	Секретный ключ	да
{API_URL}	string	Путь API	да

Методы

Название	Параметры	Результат	Описание
send	command [string]	Result	Отправка запроса к API

Класс Result

Свойства

Название	Тип	Описание	Обязательное
success	boolean	Флаг успеха операции	да
command	Command	Выполняемая команда	да
errorMessage	string	Сообщение ошибки (при провале операции)	нет
errorCode	int	Код ошибки (при провале операции)	нет
errorData	mixed	Дополнительная информация об ошибке (при провале операции)	нет

Методы

Название	Результат	Описание
getResult	Entity	При успешном выполнении вернёт сущность соответствующую команде

Пример:

    $finbox = new Finbox(
        '{TOKEN}',
        '{SECRET}',
        '{API_URL}'
    );

    $command = new ClientCreateCommand(
        ClientType::INDIVIDUAL,
        [
            'name' => 'Test client name',
            'surname' => 'Test client surname',
            'patronymic' => 'Test client patronymic',
        ],
        '[phone]'
    );

    $result = $finbox->send($command);
    
    if ($result->success) {
        $newClient = $result->getResult();    
    } else {
        die($result->errorMessage);
    }

Команды

Класс	Описание
ClientCreateCommand	Создание клиента
ClientGetCommand	Запрос клиента по ID

ClientCreateCommand

| Создание нового клиента

Параметры

Название	Тип	Описание	Обязательное
initials	Initials	ФИО	да (только параметр name)
phone	string	Запрос клиента по ID	да

Результат

При успешном создании клиента вернёт ClientEntity

ClientGetCommand

| Запрос клиента по ID

Параметры

Название	Тип	Описание	Обязательное
clientId	string	ID клиента	да

Результат

При успешном запросе вернёт ClientEntity