victor78/yii2-sms-reg

Компонент для взаимодействия с API sms-reg.com

2.0.1 2021-03-20 11:36 UTC

Requires

• php: ^7
• victor78/sms-reg: ^2
• yiisoft/yii2: ^2.0

Requires (Dev)

• phpunit/phpunit: ^5

Apache-2.0

• Victor78 aka Victor Selukov

• api
• sdk
• sms-reg

README

Компонент для запросов к API sms-reg.com

Установка

Установка при помощи Composer. Выполните команду в корневом каталоге проекта:

composer require victor78/yii2-sms-reg

Настройка

api_key необходимо получить в личном кабинете sms-reg.com

return [
    //...
    'components' => [
        'smsreg' => [
            'class' => Victor78\SmsRegComponent\Requestor::class,
            'api_key' => 'xxxxxxxxxxxxxxxxxxxx',
            'dev_key' => 'xxxxxxxxxxxxxxxxxxxx', //опционально
        ],
    ]
];

## Использование

Все публичные методы компонента носят имена аутентичных методов API согласно документации https://sms-reg.com/docs/API.html

```php
<?php

$balance_response = Yii::$app->smsreg->getBalance();
$balance = (float) $balance_response['balance'];
$list_response = Yii::$app->smsreg->getList(1);
$services = $list_response['services'];

Тесты

Выполнить команду

vendor/bin/phpunit

Для проверки со своим API KEY, в phpunit.xml указать актуальное значение PHPUNIT_SMSREG_APIKEY.