README

开放API SDK

#安装

composer require novastar/auth-api

#使用方法

在项目中引入SDK自动加载文件
实例化NovaStar\Api\Dispatch类
- 实例化NovaStar\Api\Dispatch类时的参数说明
- 节点说明，目前只有新加坡节点可用
- 权限对照表
通过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"=>"测试屏"])
- 参数说明
获取单个屏体点检信息
- getSpotChecks(["sid"=>"1111"])
- 参数说明
获取单个屏体监控数据
- getMonitors(["sid"=>"1111"])
- 参数说明
获取屏体监控图片-原始图
- getImages(["sid"=>["1111"]])
- 参数说明
获取屏体监控图片-缩略图
- getThumbnails(["sid"=>["1111"]])
- 参数说明

#单元测试

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

novastar / auth-api

维护者

详细信息

README

开放API SDK