javaabu / boli-api
PHP SDK for Ministry of Economic Development's Boli System
Requires
- php: ^7.2 || ^8.0
- guzzlehttp/guzzle: ~7.0
- illuminate/support: ^5.6|^6.0|^7.0|^8.0|^9.0
Requires (Dev)
- orchestra/testbench: ^4.0
- phpunit/phpunit: ^8.0
This package is auto-updated.
Last update: 2024-10-28 16:42:15 UTC
README
PHP SDK for Ministry of Economic Development's Boli System
Contents
Installation
You can install the package via composer:
composer require javaabu/boli-api
Laravel 5.5 and above uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider.
After updating composer, add the ServiceProvider to the providers array in config/app.php
// config/app.php 'providers' => [ ... Javaabu\Boli\BoliServiceProvider::class, ],
Optionally add the facade.
// config/app.php 'aliases' => [ ... 'Boli' => Javaabu\Boli\Facades\Boli::class, ],
Setting up the Boli API credentials
Add your Boli Username, Password, and Url (optional) to your config/services.php
:
// config/services.php ... 'boli' => [ 'username' => env('BOLI_USERNAME'), // Boli API username 'password' => env('BOLI_PASSWORD'), // Boli API password 'url' => env('BOLI_API_URL'), // optional, use only if you need to override the default, // defaults to https://api-business.egov.mv/WebApi/api/ ], ...
Usage
Using the App container:
$boli = App::make('boli'); $entity = $boli->getBusinessEntity('C-0933/2017');
Using the Facade
use Boli; $entity = Boli::getBusinessEntity('C-0933/2017');
Available Methods
Boli::getBusiness($business_registration_number); // for business entities + business names Boli::getBusinessEntity($business_registration_number); Boli::getProduct($product_registration_number); Boli::getBusinessName($business_name_registration_number); Boli::getImportLicense($import_license_number);
Testing
composer test
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email info@javaabu.com instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.
Disclaimer
This package is not in any way officially affiliated with Maldives Ministry of Economic Development. The "Boli" name has been used under fair use.