imsadhappy/laravel-kyivstar-api

Laravel package for Kyivstar API integration

0.2.0 2024-10-08 10:43 UTC

Requires

• php: ^7.4|^8.0
• ext-json: *
• guzzlehttp/guzzle: ^7.0
• illuminate/support: ^7.0|^8.0|^9.0|^10.0|^11.0

Requires (Dev)

• mockery/mockery: ^1.4.4
• orchestra/testbench: ^8.0|^9.0
• phpunit/phpunit: ^9.0|^10.5

MIT

• Andrii Serb

• sms
• kyivstar

README

Laravel пакет для роботи з Київстар Open Telecom API

Офіційна документація:

https://api-gateway.kyivstar.ua/#overview

Конфіг .env:

KYIVSTAR_API_CLIENT_ID="*Ваш Client ID"
KYIVSTAR_API_CLIENT_SECRET="*Ваш Client Secret"
KYIVSTAR_API_SERVER="mock (default), sandbox, або production"
KYIVSTAR_API_VERSION="Необов'язково, буде використана остання доступна"
KYIVSTAR_API_ALPHA_NAME="Необов'язково, можна передати параметром в сервіс"

Робота з SMS:

/** 
 * Відправити SMS
 * 
 * @param string $to - номер отримувача
 * @param string $text - повідомлення
 * @returns string $id - ідентифікатор відправленого SMS 
 */
app(KyivstarApi::class)->Sms()->send('[phone]', 'message text');
/** 
 * Перевірити статус відправки SMS
 * 
 * @param string $id - ідентифікатор відправленого SMS 
 * @returns string $status - accepted|delivered|seen
 */
app(KyivstarApi::class)->Sms()->status($id);

Робота з Viber:

/** 
 * Відправити Viber повідомелння
 * 
 * @param string $to - номер отримувача
 * @param string $text - повідомлення
 * @returns string $id - ідентифікатор відправленого Viber повідомелння 
 */
app(KyivstarApi::class)->Viber()->transaction('[phone]', 'message text');

/** 
 * Відправити Viber повідомелння з картинкою (і кнопкою)
 * 
 * @param string $to - номер отримувача
 * @param string $text - повідомлення
 * @param int|null $messageTtlSec
 * @param string|null $img - посилання на зображення
 * @param string|null $caption - текст кнопки (необов'язково)
 * @param string|null $action - посилання кнопки (необов'язково)
 * @returns string $id - ідентифікатор відправленого Viber повідомелння 
 */
app(KyivstarApi::class)->Viber()->promotion('[phone]',
                                            'message text',
                                            null /* ttl, default 1209600 */,
                                            'https://example.com/image.jpg',
                                            'Click Me',
                                            'https://example.com/');

/** 
 * Перевірити статус відправки Viber повідомелння
 * 
 * @param string $id - ідентифікатор відправленого Viber повідомелння 
 * @returns string $status - accepted|delivered|seen
 */
app(KyivstarApi::class)->Viber()->status($id);

Інше

Alpha Name можна задати для всіх сервісів в .env або передавати в кожний сервіс окремо.

app(KyivstarApi::class)->Sms('Foo');
app(KyivstarApi::class)->Viber('Bar');

Виклик сервісів варто огортати в try ... catch блок. Можливі Config..., Value... і Http помилки (див. src/Exceptions і трейти типу Validator в src/Traits).

try {
    app(KyivstarApi::class)-> ...
} catch (\Exception $e) {
    ...
}

Перелік деяких можливих помилок:

ConfigException (with codes: 1-4)
ValueException:
    ValueIsEmptyException
    ValueIsNotAllowedException
    ValueNotBetweenException
    ValueNotUrlException
    ValueTooLongException
    ValueTooShortException
AuthenticationException
NotFoundHttpException
UnprocessableEntityHttpException
RequestException

Changelog

Version 0.2.1

• added MessengerInterface implemented by SmsService & ViberService
• minor tests refactoring

Version 0.2.0

• beta release - added tests

Version 0.1.9

• fix message (sms, transaction) segmentation

Version 0.1.8

• updated readme
• made api & services final
• added MAX_TTL to Sms & Transaction DTOs
• changed VersionedTestCase to set up authentication facade

Version 0.1.7

• added VersionedTestCase for version-aware tests (now used in AuthenticationServiceTest, SmsServiceTest & ViberServiceTest)

Version 0.1.6

• added SEGMENT_SIZE & MAX_SEGMENT_COUNT to Sms DTO.
• added TTL to AuthenticationService
• fix: ViberService response receives 'mid' not 'msgId' param
• moved SmsTest & ViberPromotionTest to feature
• made AuthenticationServiceTest version-aware (v1beta)
• added feature tests: SmsServiceTest & ViberServiceTest (v1beta)

Version 0.1.5

• added feature tests: AuthenticationServiceTest
• refactoring: TestCase, ConfigValidatorTest, HasAlphaNameTest, HttpValidatorTest
• made JsonHttpService & AuthenticationService future-proof in case of endpoint changes

Version 0.1.4

• added 404 NotFoundHttpException to HttpValidator and respective test (+ minor refactoring of test)

Version 0.1.3

• added unit tests (for DTOs & traits): ConfigValidatorTest, HasAlphaNameTest, HttpValidatorTest, ObjectToArrayTest, ValueValidatorTest, SmsTest, ViberPromotionTest
• added supportedVersions list & exception codes to ConfigValidator trait

Version 0.1.2

• refactoring: AuthenticationService

Version 0.1.1

• refactoring: exposed get|post|put in JsonHttpService instead of try

Version 0.1.0

• alpha release

Version 0.0.4

• new traits: HttpValidator (for JsonHttpService & AuthenticationService) & ConfigValidator
• moved isValidConfig from ValueValidator to ConfigValidator
• removed excessive use declarations

Version 0.0.3

• added traits: ObjectToArray (for Message & Viber/ContentExtended DTOs)
• minor refactoring

Version 0.0.2

• AuthenticationService nolonger extends HttpService
• DTOs props array removed in favor of direct properties
• added config validation
• new method: ValueValidator:isValidConfig
• new exceptions: ConfigException, ValueIsNotAllowedException
• renamed: HttpService -> JsonHttpService, config.php -> kyivstar-api.php
• removed: PropsIterator

Version 0.0.1

• initial commit: Facade, ServiceProvider
• new services: HttpService, AuthenticationService, SmsService, ViberService
• new traits: HasAlphaName, PropsIterator, ValueValidator
• new DTOs: Message, Sms, Viber/Transaction, Viber/Promotion, Viber/ContentExtended
• new exceptions: ValueException, ValueIsEmptyException, ValueNotUrlException, ValueTooLongException, ValueTooShortException, ValueNotBetweenException