kazinokib/bdappsapi

A Laravel package for BDApps API integration

1.0.0 2024-09-15 09:04 UTC

Requires

• php: ^7.3|^8.0|^8.1|^8.2
• guzzlehttp/guzzle: ^7.0
• illuminate/support: ^8.0|^9.0|^10.0|^11.0

Requires (Dev)

• orchestra/testbench: ^6.0|^7.0|^8.0|^9.0
• phpunit/phpunit: ^9.0|^10.0

MIT

• Kazi Mohammad Nokib

README

This Laravel package provides an easy-to-use interface for integrating with the BDApps API, allowing you to send SMS, handle USSD sessions, manage OTP, and perform CAAS operations in your Laravel applications.

Table of Contents

1. Installation
2. Configuration
3. Usage
   • SMS Service
   • USSD Service
   • OTP Service
   • CAAS Service
4. Error Handling
5. Contributing
6. License

Installation

You can install the package via composer:

composer require kazinokib/bdappsapi

Configuration

After installation, publish the configuration file:

php artisan vendor:publish --provider="Kazinokib\BdappsApi\BdappsApiServiceProvider" --tag="config"

This will create a config/bdappsapi.php file in your app's configuration directory. You should configure your BDApps API credentials in your .env file:

BDAPPS_APP_ID=your_app_id
BDAPPS_APP_PASSWORD=your_app_password
BDAPPS_BASE_URL=https://developer.bdapps.com

Usage

SMS Service

To send an SMS:

use Kazinokib\BdappsApi\BdappsApi;

public function sendSms(BdappsApi $bdappsApi)
{
    $result = $bdappsApi->smsService->send('Your message', ['tel:[phone]']);
    // Handle the result
}

Receive SMS

use Kazinokib\BdappsApi\BdappsApi;

public function receiveSms(BdappsApi $bdappsApi)
{
    $result = $bdappsApi->smsService->receiveSms();
    // Handle the result
}

USSD Service

To send a USSD message:

use Kazinokib\BdappsApi\BdappsApi;

public function sendUssd(BdappsApi $bdappsApi)
{
    $result = $bdappsApi->ussdService->send('Your message', 'session_id', 'tel:[phone]');
    // Handle the result
}

OTP Service

To request an OTP:

use Kazinokib\BdappsApi\BdappsApi;

public function requestOtp(BdappsApi $bdappsApi)
{
    $result = $bdappsApi->otpService->requestOtp('tel:[phone]');
    // Handle the result
}

To verify an OTP:

use Kazinokib\BdappsApi\BdappsApi;

public function verifyOtp(BdappsApi $bdappsApi)
{
    $result = $bdappsApi->otpService->verifyOtp('reference_no', 'otp_code');
    // Handle the result
}

CAAS Service

To query balance:

use Kazinokib\BdappsApi\BdappsApi;

public function queryBalance(BdappsApi $bdappsApi)
{
    $result = $bdappsApi->caasService->queryBalance('tel:[phone]');
    // Handle the result
}

To perform a direct debit:

use Kazinokib\BdappsApi\BdappsApi;

public function directDebit(BdappsApi $bdappsApi)
{
    $result = $bdappsApi->caasService->directDebit('external_tx_id', 'tel:[phone]', 10.00);
    // Handle the result
}

Error Handling

All services throw a BdappsApiException on error. You should catch this exception and handle it appropriately:

use Kazinokib\BdappsApi\Exceptions\BdappsApiException;

try {
    $result = $bdappsApi->smsService->send('Your message', ['tel:[phone]']);
} catch (BdappsApiException $e) {
    // Handle the exception
    $errorCode = $e->getErrorCode();
    $errorDetail = $e->getErrorDetail();
}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This package is open-sourced software licensed under the MIT license.