Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alkhatibdev/laravel-sudani
Sudani SPay API integration with Laravel, was made to simplify the process and API calls and let developers focus on other integration parts and logic.
https://github.com/alkhatibdev/laravel-sudani
laravel laravel-framework php
Last synced: 6 days ago
JSON representation
Sudani SPay API integration with Laravel, was made to simplify the process and API calls and let developers focus on other integration parts and logic.
- Host: GitHub
- URL: https://github.com/alkhatibdev/laravel-sudani
- Owner: alkhatibdev
- License: mit
- Created: 2022-07-15T13:02:54.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-23T06:08:06.000Z (8 months ago)
- Last Synced: 2024-09-24T17:03:18.102Z (9 days ago)
- Topics: laravel, laravel-framework, php
- Language: PHP
- Homepage: https://github.com/alkhatibdev/laravel-sudani
- Size: 39.1 KB
- Stars: 19
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sudani SPay API integration with Laravel
[](https://github.com/alkhatibdev/laravel-sudani/releases)
[](LICENSE)
# Introduction
Laravel Sudani is Sudani SPay API integration with Laravel, made to simplify the process and API calls and let developers focus on other integration parts and logic. See also [Laravel Zain](https://github.com/alkhatibdev/laravel-zain).
# Installation
## Requirements
- PHP >= `7.4.x`
- Laravel >= `7.x`
## install via composer
```shell
composer require alkhatibdev/laravel-sudani
```
## Publish Configs
```shell
php artisan vendor:publish --tag=laravel-sudani-config
```
A `laravel-sudani.php` config file will be published on your `configs` directory, with the following content:
```php
env('SUDANI_SERVER_BASE_API_URL'),
'provider_key' => env('SUDANI_PROVIDER_KEY'),
'service_code' => env('SUDANI_SERVICE_CODE'),
'username' => env('SUDANI_USERNAME'),
'password' => env('SUDANI_PASSWORD'),
'enable_logging' => false,
];
```
Don't forget to set all these variables on your `.env` file
```env
SUDANI_SERVER_BASE_API_URL=http://196.1.241.110/SPayAPI/Service/
SUDANI_PROVIDER_KEY=xxxxxxxx
SUDANI_SERVICE_CODE=xxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
SUDANI_USERNAME=xxxxxx
SUDANI_PASSWORD=xxxxxx
```
# Usage
## Initial Payment/Subscription
```php
use AlkhatibDev\LaravelSudani\Facades\Sudani;
// Initiate payment request
$response = Sudani::initiate($phone)
```
When the `initiate` payment request is successfully sent, an SMS with an `OTP` code will be sent to the `$phone` number, and `$response` will contain a `requestId` and you should save it to the next step `verify`.
## Verify Payment/Subscription
```php
$response = Sudani::verify($otp, $requestId)
```
## Check Subscription
```php
$response = Sudani::checkSubscription($phone)
```
## Unsubscribe
```php
$response = Sudani::unsubscribe($phone)
```
## Login and Cache SPay token
Out of the box, the package will encrypt the password and login automatically and get the `token` and use it for each action `initiate`, `verify` ..etc per request.
If you want to cache the token and use it for further requests, you can request a `token` like this:
```php
$token = Sudani::token()
```
And you can cache it and use it for each request for the next 24 hours, for example:
```php
// $token = getCachedToken()
$response = Sudani::withToken($token)->initiate($phone)
$response = Sudani::withToken($token)->verify($phone)
...
```
## Logging
You can enable logging from the package config file
```
'enable_logging' => true,
```
# Other Packages
- ### [Laravel Zain](https://github.com/alkhatibdev/laravel-zain) DSP API Integration
# License
Laravel Sudani is open-sourced software licensed under the [MIT license](LICENSE).