arttiger/laravel-ubki

Laravel package for integration with UBKI

v1.1.0 2023-04-10 10:06 UTC

Requires

• illuminate/support: 5.6.39|5.7.*|5.8.*|^6.0|^7.0|^8.0|^9.0|^10.0

Requires (Dev)

• mockery/mockery: ^1.1
• orchestra/testbench: ~3.0
• phpunit/phpunit: ^7.5
• sempro/phpunit-pretty-print: ^1.0
• styleci/cli: ^1.1

MIT

• Volodymyr Farylevych

• laravel
• Ubki

README

Украинское бюро кредитных историй (УБКИ) занимается сбором, хранением, обработкой и предоставлением кредитных историй. УБКИ получает информацию о заемщиках от банков, страховых компаний, лизинговых компаний, кредитных союзов и других финансовых институтов. Информация передается на добровольной основе и только при наличии письменного согласия заемщика.

Для автоматизации взаимодействия с УБКИ существует web-сервис, который принимает запросы, обрабатывает и выдает ответ в зависимости от типа запроса.

This package allows you to simply and easily work with the web-service UBKI.

Installation

Install the package via composer:

$ composer require arttiger/laravel-ubki

Next, you need to run migrations:

$ php artisan migrate

Configuration

In order to edit the default configuration you may execute:

php artisan vendor:publish --provider="Arttiger\Ubki\UbkiServiceProvider"

After that, config/ubki.php will be created.

Environment

Set environment variable (.env)

UBKI_TEST_MODE=true
UBKI_ACCOUNT_LOGIN=
UBKI_ACCOUNT_PASSWORD=
UBKI_AUTH_URL=https://secure.ubki.ua/b2_api_xml/ubki/auth
UBKI_REQUEST_URL=https://secure.ubki.ua/b2_api_xml/ubki/xml
UBKI_UPLOAD_URL=https://secure.ubki.ua/upload/data/xml
UBKI_TEST_AUTH_URL=https://secure.ubki.ua:4040/b2_api_xml/ubki/auth
UBKI_TEST_REQUEST_URL=https://secure.ubki.ua:4040/b2_api_xml/ubki/xml
UBKI_TEST_UPLOAD_URL=https://secure.ubki.ua:4040/upload/data/xml

Usage

Add IntegratorUbki-trait to the model with client data:

    use Arttiger\Ubki\Traits\IntegratorUbki;

    class Loan extends Model
    {
        use IntegratorUbki;
        ...
    }

Set the necessary the mapping variables in config/ubki.php:

'model_data' => [
  'okpo'  => 'inn',           // ИНН
  'lname' => 'lastName',      // Фамилия
  'fname' => 'firstName',     // Имя
  'mname' => 'middleName',    // Отчество
  'bdate' => 'birth_date',    // Дата рождения (гггг-мм-дд)
  'dtype' => 'passport_type', // Тип паспорта (см. справочник "Тип документа")
  'dser'  => 'passport_ser',  // Серия паспорта или номер записи ID-карты
  'dnom'  => 'passport_num',  // Номер паспорта или номер ID-карты
  'ctype' => 'contact_type',  // Тип контакта (см. справочник "Тип контакта")
  'cval'  => 'contact_val',   // Значение контакта (например - "[phone]")
  'foto'  => 'foto',          // <base64(Фото)>
],

This map establishes the correspondence between the attributes of your model and the required query fields in UBKI.

Add a new method ubkiAttributes() to the class to add the necessary attributes and fill them with data:

    use Arttiger\Ubki\Traits\IntegratorUbki;

    class Loan extends Model
    {
        use IntegratorUbki;
        ...
        
        public function ubkiAttributes($params = [])
        {
            $client_data = json_decode($this->attributes['client_data']);
            $this->attributes['inn']        = trim($client_data->code); 
            $this->attributes['lastName']   = trim($client_data->lastName); 
            ...
        }
    }

You can use other ways to create custom attributes that you specified in 'model_data' (config/ubki.php).

Now, you can get data from UBKI:

$loan = Loan::find(1); 
$result = $loan->ubki();

$result['response'] - xml response from UBKI (standard report).

You can also pass parameters:

$result = $loan->ubki($params);

• $params['report'] - report alias, if you need other reports;
• $params['request_id'] - your request ID (if necessary);
• $params['lang'] - search language;
• $params['delete_all_history'] - set true if you want delete all history;

You can send the loan data to UBKI:

$result = $loan->ubki_upload($params);

$params - will be passed to the ubkiAttributes() method in the model.

For switching between accounts you should add to params:

• to select second account

$params = [
    'test' => false,
    'use_second_account_login' => true
];

• to select main account

$params = [
    'test' => false,
    'use_second_account_login' => false
];

if you not select what account to use, last used account will be executed.

Change log

Please see the changelog for more information on what has changed recently.

Security

If you discover any security related issues, please email author email instead of using the issue tracker.

Credits

Volodymyr Farylevych

License

Please see the license file for more information.