README

什么是 ClubKonnect

ClubKonnect API 是一个 HTTPS GET API，允许您将我们平台上的所有 ClubKonnect 虚拟充值和账单支付服务集成到您的应用程序中（网站、桌面应用程序和移动应用程序）。您还可以通过集成我们的 VTU API 并在尼日利亚转售我们的服务来开始自己的 VTU 业务。

什么是 Laravel ClubKonnect

Laravel ClubKonnect 是一个 Laravel 扩展包，用于在 Laravel 应用程序中无缝集成 ClubKonnect API。

创建 ClubKonnect 账户 注册。

查看 ClubKonnect API 文档 API 文档。

安装

您可以通过 composer 安装此包

composer require henryejemuta/laravel-clubkonnect

发布 ClubKonnect 配置文件、迁移以及设置 .env 文件中的默认详情

php artisan clubkonnect:init

使用方法

重要：在使用响应之前，请使用 $response->successful() 检查响应状态，并在请求失败时优雅地抛出并处理 ClubKonnectErrorException

在进行任何交易之前，请检查您的余额，以确认您有足够的 ClubKonnect 余额来处理交易

通过 ClubKonnect 门面，Laravel ClubKonnect 包的使用非常简单

use HenryEjemuta\LaravelClubKonnect\Facades\ClubKonnect;
use HenryEjemuta\LaravelClubKonnect\Classes\ClubKonnectResponse;

...
//Check ClubKonnect Balance
    $response = ClubKonnect::getWalletBalance();
    if ($response->successful()) {
        $body = $response->getBody();
        echo "Your {$body->phoneno} ClubKonnect Balance is {$body->balance}";
    } else {
        $exception = $response->getErrorException();
        Log::error("Error while checking balance\n\r" . $exception->getCode() . ": " . $exception->getMessage());
    }

//To buy Airtime
    $response = ClubKonnect::purchaseAirtime(NetworkEnum::getNetwork('mtn'), '1500', '08134567890', 'MY_UNIQUE_TXN_ID', 'https://example.com/afterorderurl');
    if (!$response->successful()) {
            $exception = $response->getErrorException();
        Log::error("Error while purchasing airtime\n\r" . $exception->getCode() . ": " . $exception->getMessage());
    }

...

查看所有方法的概述，包括注释和预期参数

        /**
         * Check your Server IP
         * @return ClubKonnectResponse
         */
        public function checkYourServerIP(): ClubKonnectResponse
    
        /**
         * Get Your wallet available balance, Wallet is identified by username set in clubkonnect config or environmental variable
         * @return ClubKonnectResponse
         */
        public function getWalletBalance(): ClubKonnectResponse
    
        /**
         * @param NetworkEnum $mobileNetwork
         * @param int $amount
         * @param $phoneNumber
         * @param $requestID
         * @param $callbackUrl
         * @return ClubKonnectResponse
         */
        public function purchaseAirtime(NetworkEnum $mobileNetwork, int $amount, $phoneNumber, $requestID, $callbackUrl): ClubKonnectResponse
    
        /**
         * ClubKonnect API Transaction handler to access:
         * CableTv()->queryByOrderID(string $orderID);
         * CableTv()->queryByRequestID(string $requestID);
         * CableTv()->cancelTransaction(string $orderID);
         *
         * @return Transaction
         */
        public function Transaction(): Transaction
    
        /**
         * Smile Bill handler to access:
         * CableTv()->getDataBundles();
         * CableTv()->verifySmileAccountID($phoneNumber);
         * CableTv()->purchaseBundle(string $plan, string $phoneNumber, $requestID, $callbackUrl = null);
         *
         * @return Smile
         */
        public function Smile(): Smile
    
        /**
         * Cable TV Bill handler to access:
         * CableTv()->getTvPackages();
         * CableTv()->verifyCustomerID(CableTvEnum $cableTv, $smartCardNo);
         * CableTv()->purchasePackage(CableTvEnum $cableTv, string $package, $smartCardNo, $requestID, $callbackUrl = null);
         *
         * @return CableTv
         */
        public function CableTv(): CableTv
    
        /**
         * Recharge Card Printing handler to access:
         * RechargeCardPrinting()->getEPinNetworks();
         * RechargeCardPrinting()->buyEPins(NetworkEnum $network, $amount, int $quantity, $requestID, $callbackUrl = null);
         *
         * @return RechargeCardPrinting
         */
        public function RechargeCardPrinting(): RechargeCardPrinting
    
    
        /**
         * Get all Data Bundles
         * @return ClubKonnectResponse
         */
        public function getDataBundles(): ClubKonnectResponse
    
    
        /**
         * @param NetworkEnum $network
         * @param string $plan
         * @param string $phoneNumber
         * @param $requestID
         * @param $callbackUrl
         * @return ClubKonnectResponse
         */
        public function purchaseDataBundle(NetworkEnum $network, string $plan, string $phoneNumber, $requestID, $callbackUrl): ClubKonnectResponse

        
    /**
     * Electricity Bills payment handler to access:
     * Electricity()->getDiscosAndMinMax();
     * Electricity()->verifyMeterNumber(DiscoEnum $disco, $meterNumber): ClubKonnectResponse
     * Electricity()->buyElectricity(DiscoEnum $disco, $meterNumber, $amount, MeterTypeEnum $meterType, $requestID, $callbackUrl = null): ClubKonnectResponse
     *
     * @return Electricity
     */
    public function Electricity(): Electricity

测试

composer test

更新日志

请参阅 更新日志 了解最近更改的详细信息。

贡献

请参阅 贡献 了解详细信息。

安全

如果您发现任何安全问题，请通过电子邮件发送给 henry.ejemuta@gmail.com，而不是使用问题跟踪器。

鸣谢

• Henry Ejemuta
• 所有贡献者

许可证

MIT 许可证（MIT）。有关更多信息，请参阅 许可证文件。

Laravel 包模板

此包是使用 Laravel 包模板 生成的。