README

The free Laravel package to help you integrate with vitepay.dev

Use Cases

Create and manage software with vitepay.dev
Manage devices with vitepay.dev
Create and manage licenses with vitepay.dev

Features

Dynamic vitepay.dev credentials from config/vitepay.php
Easy to manage your software licenses with a few lines of coding

Requirements

PHP: 8.1 or higher
Laravel 9.0 or higher

Quick Start

If you prefer to install this package into your own Laravel application, please follow the installation steps below

Installation

Step 1. Install a Laravel project if you don't have one already

https://laravel.com/docs/installation

Step 2. Require the current package using composer:

composer require vitegroupltd/vitepay-laravel-integrate

Step 3. Publish the controller file and config file

php artisan vendor:publish --provider="ViteGroup\VitePay\VitePayServiceProvider" --tag="vitepay"

If publishing files fails, please create corresponding files at the path config/vitepay.php and app\Http\Controllers\VitePayControllers.php from this package. And you can also further customize the VitePayControllers.php file to suit your project.

Step 4. Update the various config settings in the published config file:

After publishing the package assets a configuration file will be located at config/vitepay.php. Please find in vitepay.dev to get those values to fill into the config file.

Step 5. Add middleware protection:

app/Http/Kernel.php

<?php

namespace App\Http;

use Illuminate\Foundation\Http\Kernel as HttpKernel;

class Kernel extends HttpKernel
{
    // Other kernel properties...
    
    /**
     * The application's route middleware groups.
     *
     * @var array
     */
    protected $routeMiddleware = [
        // Other middlewares...
         'vitepay' => 'App\Http\Middleware\VitePayMiddleware',
    ];
}

Step 6. Add route:

routes/api.php

<?php

use Illuminate\Support\Facades\Route;
use App\Http\Controllers\VitePayController;

// Other routes properties...

Route::group(['middleware' => ['vitepay']], function () {
    Route::post('/vitepay/webhook', [VitePayController::class, 'webhook']);
});

}

Then your IPN (Webhook) URL will be something like https://yourdomain.ltd/api/vitepay/webhook, and you should provide it to VitePay's account setting. You could provide it to routes/web.php if you want but remember that VitePay will check for referer matched with the pre-registration URL. So make sure that you provide them the right URL of website.

Testing

<?php

namespace App\Console\Commands;

use GuzzleHttp\Exception\GuzzleException;
use ViteGroup\VitePay\VitePayTransactions;
use Illuminate\Console\Command;

class VitePayTestCommand extends Command
{
    protected $signature = 'vitepay:test';

    protected $description = 'Test VitePay SDK';

    public function __construct()
    {
        parent::__construct();
    }

    /**
     * @throws GuzzleException
     */
    public function handle()
    {
        $instance = new VitePayTransactions();
        print_r($instance->create(
            'INV-test-01',
            '',
            100000,
            'Description-test-01'
        ));
    }
}

RESTful API Documentation

Please see POSTMAN DOCUMENTATION for details.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email contact@ViteGroup.vn or use the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

vitegroupltd / vitepay-laravel-integrate

Maintainers

Details