nicelighting/nicelaravel

此包最新版本(dev-main)没有可用的许可信息。

Nice外部平台使用composer包(laravel)

dev-main 2022-06-01 02:05 UTC

This package is auto-updated.

Last update: 2024-09-29 05:57:02 UTC


README

README中文版

概述

Nice是一个面向外部的集成管理平台。

运行环境

  • PHP 7.2+。
  • Firebase/php-jwt 5.4
  • Guzzlehttp/guzzle 6.5。

安装Nice

  • 如果您使用composer管理项目依赖,请在项目根目录中运行以下命令

      composer require niceopening/nice-laravel
    

    您也可以在composer.json文件中声明对Nice Laravel的依赖。

      "require": {
          "niceopening/nice-laravel": "dev-master"
      }
    

    然后运行composer install来安装依赖。在Composer依赖管理器安装后,将依赖导入您的PHP代码中

      require_once __DIR__ . '/vendor/autoload.php';
    
  • 您还可以直接下载打包的[PHAR文件][releases-page],并将文件引入到您的代码中

      require_once '/path/to/nice-opening.phar';
    
  • 下载SDK源代码,并将SDK目录下的autoload.php文件引入到您的代码中

      require_once '/path/to/nice-opening/autoload.php';
    

快速使用

常用类

示例

nice关键字是请求接口路由的最后两个值。如果您想请求https://nice.zebra-c.com/api/project/list接口,则您的密钥应该是project_list

Nice的操作通过NiceExternal类执行。下面的代码创建了一个NiceExternal对象

<?php
$accessKeyId = "<AccessKeyID that you obtain from Nice>";
$accessKeySecret = "<AccessKeySecret that you obtain from Nice>";
try {
    $key = "project_create"; //Key that you used to request nice interface eg:project/create
    $data = ['project_name' => 'test', 'data_type' => '1']; //Interface parameters require incoming data,please refer to the Nice Interface documentation.
    $niceExternal = new NiceExternal($accessKeyId, $accessKeySecret);
    $niceExternal->dealRequest($key, $data);
} catch (\Exception $e) {
    print $e->getErrorMessage();
}

运行单元测试

  • 运行composer install下载依赖库。

  • 设置环境变量。

      export NICE_ACCESS_KEY_ID=access-key-id
      export NICE_ACCESS_KEY_SECRET=access-key-secret
    
  • 运行php vendor/bin/phpunit

联系我们