novastar/auth-api

open api sdk

1.0.2 2019-01-11 09:17 UTC

Requires

• php: >=5.6.4
• doctrine/cache: ~1.6.0
• guzzlehttp/guzzle: 6.3.0
• guzzlehttp/promises: 1.3.1
• guzzlehttp/psr7: 1.4.2
• league/container: ~2.4.0
• monolog/monolog: 1.23.0
• nesbot/carbon: 1.32.0
• phpunit/phpunit: ~5.7
• pimple/pimple: ^3.0
• tightenco/collect: ~5.4.16

MIT

• liuzq

README

Open API SDK

#安装

• composer require novastar/auth-api

#使用方法

• 在项目中引入SDK自动加载文件
• 实例NovaStar\Api\Dispatch类

  • 实例化NovaStar\Api\Dispatch类时，参数说明

    参数名	必选	类型	默认值	说明
    node	true	string	无	服务器节点,具体值请看node节点说明
    app_id	true	string	无	客户端ID
    app_secret	true	string	无	客户端secret
    scope	false	string	无	接口权限,默认为全部,多个权限用","隔开,具体参考权限对照表
    cache	true	class	无	缓存类，系统提供doctrine/cache中缓存类,用户也可基于此实现自己的缓存类
    log	true	string	无	日志目录

  • node节点说明,目前只有新加坡节点可用

    服务器节点	value
    中国节点	cn
    新加坡节点	sg
    美国节点	us

  • 权限对照表

    scope	接口
    user-tags	获取用户标签列表
    screen-lists	获取用户屏体列表
    screen-spotcheck	获取用户单个屏体点检信息
    screen-monitor	获取用户单个屏体监控数据
    screen-images	获取屏体监控图片(原始图)-多摄像机
    screen-thumbnails	获取用户屏体监控图片(缩略图)-多摄像机

• 通过Dispatch类调用各API方法
• 比如获取用户标签:

	require_once __DIR__ . "/vendor/autoload.php";
	use NovaStar\Api\Dispatch;
	use Doctrine\Common\Cache\FilesystemCache;
	use NovaStar\Api\Exceptions\HttpException;
	$apiDispatch = new Dispatch(
		[
			"node" => "cn",
			"app_id" => "3f6deaafb426e72dc88addda6423190ca18efd7287a1e311417da7ee",
			"app_secret" => "E478IXfjQ5Exf6kCCMEIuyvFKSkRdimWxSmQvByV",
			"scope" => "",
			"cache" => new FilesystemCache(dirname(__DIR__ . '/runtime/cache')),
			"log" => [
				"level" => "ERROR",
				"path" => __DIR__ . "/runtime/log/novastar.log"
			]
		]
	);

	try{
		$tags = $apiDispatch->getTags();
		echo '<pre>';
		print_r($tags);
		echo '</pre>';
	}catch(HttpException $e){
		var_dump($e->getMessage());
	}

• 具体请参考Demon中test.php

#目前提供的API方法

• 获取用户标签列表
  • getTags()
• 获取显示屏列表

  • getScreenList(["status"=>2,"label"=>222,"search"=>"测试屏"])

  • 参数说明

    参数名	必选	类型	默认值	说明
    status	false	int	无	屏体状态1：在线2：离线3：告警4：故障
    label	false	int	无	标签ID
    search	false	string	无	搜索关键字,支持屏体名称和地址查找

• 获取单个屏体点检信息

  • getSpotChecks(["sid"=>"1111"])

  • 参数说明

    参数名	必选	类型	默认值	说明
    sid	true	string	无	屏体ID

• 获取单个屏体监控数据

  • getMonitors(["sid"=>"1111"])

  • 参数说明

    参数名	必选	类型	默认值	说明
    sid	true	string	无	屏体ID

• 获取屏体监控图片-原始图

  • getImages(["sid"=>["1111"]])

  • 参数说明

    参数名	必选	类型	默认值	说明
    sid	true	array	无	屏体ID列表

• 获取屏体监控图片-缩略图

  • getThumbnails(["sid"=>["1111"]])

  • 参数说明

    参数名	必选	类型	默认值	说明
    sid	true	array	无	屏体ID列表

#单元测试

• 进入tests目录
• 执行以下命令
  • phpunit -c phpunit.xml ./Units/DispatchTest.php