javaabu/customs-api

PHP SDK for interacting with the Maldives Customs Service API

v0.3.0 2022-08-04 13:28 UTC

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

MIT

• Arushad Ahmed

README

PHP SDK for interacting with the Maldives Customs Service API

Contents

• Installation
  • Setting up the Customs API credentials
• Usage
  • Available Methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License
• Disclaimer

Installation

You can install the package via composer:

composer require javaabu/customs-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\Customs\CustomsServiceProvider::class,
],

Optionally add the facade.

// config/app.php
'aliases' => [
    ...
    'Customs' => Javaabu\Customs\Facades\Customs::class,
],

Setting up the Customs API credentials

Add your Customs Username, Password, and Url (optional) to your config/services.php:

// config/services.php
...
'customs' => [
    'username' => env('CUSTOMS_USERNAME'), // Customs API username 
    'password' => env('CUSTOMS_PASSWORD'), // Customs API password 
    'url' => env('CUSTOMS_API_URL'), // optional, use only if you need to override the default,
                                  // defaults to https://api.customs.gov.mv/api/
],
...

Usage

Using the App container:

$customs = App::make('customs');
$entity = $customs->getTraderByMedNumber('C-0933/2017');

Using the Facade

use Customs;

$entity = Customs::getTraderByMedNumber('C-0933/2017');

Available Methods

Customs::getTraderByMedNumber($business_registration_number);
Customs::getTraderByCNumber($impoter_exporter_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 [e-mail] instead of using the issue tracker.

Credits

• Javaabu Pvt. Ltd.
• Arushad Ahmed (@dash8x)
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

Disclaimer

This package is not in any way officially affiliated with Maldives Customs Service. The "Customs" name has been used under fair use.