fsi_engine/fsi_php_sdk

此软件包是fsi引擎提供方端点的SDK

dev-main 2022-06-01 18:27 UTC

This package is auto-updated.

Last update: 2024-09-29 05:56:54 UTC


README

enter image description here

PHP SDK

简介

此软件包提供了将提供方API集成到您的应用程序中的代码服务。该SDK是为了方便访问FSI下的提供方而构建的,以便轻松集成到您的开发代码库中。

API提供方

此软件包包含FSI下的多个API提供方。您可以在FSI沙盒仪表板中找到API提供方(https://fsi.ng/members/apis)。

安装

  • 克隆此存储库: git clone https://github.com/fsi-dev/fsi-php-sdk
  • 安装依赖项: composer install
  • 运行所有测试以确认: composer test

现在您可以使用此SDK来充分利用它。您现在可以将 sdk 集成到您的应用程序代码库中。

使用方法

在克隆后,您可以在您的php/laravel本地项目中轻松使用此 sdk

  1. 首先,将FSIEngine和Meta类添加到相应的控制器类中

    use FsiEngine\SDK\FsiEngine;

  2. 您可以在控制器类中的任何地方声明 FsiEngine 类以初始化FSI引擎SDK,但建议在构造函数中声明,以便轻松访问控制器类中的方法

     use FsiEngine\SDK\FsiEngine;
    
     class myCustomClassName {
         public function __construct() {
             // Initialize FSI Engine
             FsiEngine::init($YOUR_SANDBOX_KEY, $DEPLOYMENT_TYPE);
         }
     }
    
     // init() method takes in two parameters ($YOUR_SANDBOX_KEY,  $DEPLOYMENT_TYPE):
    

    $YOUR_SANDBOX_KEY:沙盒应用程序密钥位于您为应用程序创建的应用程序示例中。您点击左侧菜单中的应用程序部分即可访问所有应用程序

    $DEPLOYMENT_TYPE:这是一个标志,表示您要使用 sdk 的部署类型。FSI引擎提供两种部署类型

    • 测试

    • 实时

        use FsiEngine\Constants\Meta;
      
        Meta::TESTING_DEPLOYMENT_TYPE // This is for testing
        Meta::LIVE_DEPLOYMENT_TYPE // This is for when you want to go live
      

    您可以在初始化FSI引擎SDK时使用这些Meta常量作为参数值。

  3. 您现在可以写入 SDK 包中提供的任何可用API提供方,并发送HTTP请求

     $processAirtimeProvider = FsiEngine::AfricasTalkingProvider()->Airtime;
     $response = $processAirtimeProvider->send($formData);
    
     // send() method takes in 2 parameters (array $MY_FORM_DATA, array $REQUEST_HEADER)
    

    $MY_FORM_DATA:这是将通过HTTP请求传递的请求正文/参数。
    $REQUEST_HEADER:这是一组传递到HTTP请求头的数据。这是以 array 的形式。

示例

以下是如何调用任何提供方的示例

    use FsiEngine\Constants\Meta;
    use FsiEngine\SDK\FsiEngine;

    class myCustomClassName{

        public function __construct() {
            //Initialize FSI Engine SDK
            FsiEngine::init(Meta::TESTING_APP_KEY, Meta::TESTING_DEPLOYMENT_TYPE);
        }

        public function myCustomMethod(){
            $formData = [
                "Referenceid"           => '01',
                "RequestType"           => '01',
                "Translocation"         => '01',
                "Bvn"                   => '01139174927',
                "billerid"              => '01'

            ];

            $header = [ // Additional Headers...
                'Ocp-Apim-Subscription-Key' => 't',
                'Ocp-Apim-Trace'            => 'true',
                'Appid'                     => 69,
                'ipval'                     => 0
            ];

            $processGetBillersISWProvider = FsiEngine::SterlingBankProvider()->GetBillersISW;
            $response = $processGetBillersISWProvider->send($formData, $header);

        }
    }

贡献

有关详细信息,请参阅我们的贡献指南

安全

如果您发现任何安全相关的问题,请通过电子邮件info@fsi.ng而不是使用问题跟踪器。

联系我们

在安全漏洞、错误检测和其他开发查询的情况下,您可以联系info@fsi.ng,并且您还可以拨打08033080471联系我们。