mediumart/orange

A laravel wrapper/adapter for orange api services.

2.0.0 2021-12-28 13:14 UTC

This package is auto-updated.

Last update: 2024-10-28 19:34:02 UTC


README

Build Status Coverage Status Latest Stable Version License

Description

A laravel wrapper/adapter for orange api services.

Installation

Using composer:

$ composer require mediumart/orange

If you are using laravel 5.3+ prior to version 5.5, add this to your config/app.php inside the 'providers' array

Mediumart\Orange\OrangeServiceProvider::class

SMS Api

Configuration

Open the config/services.php and add a key for the orange>sms service like this:

'orange' => [
    'sms' => [
        'client_id' => '<client_id>',
        'client_secret' => '<client_secret>'
    ]
]

Using these credentials, a token will be fetched and cached, and then automatically be renewed a few days before its expiration.

How to use

You can resolve an SMS client instance from the Container like this:

$sms = app('orange-sms');

Or using type hinting

use Mediumart\Orange\SMS\SMS;

public function index(SMS $sms) 
{
    /.../
}

The documentation on how to use the $sms client instance can be found here

License

Mediumart orange is an open-sourced software licensed under the MIT license.