newestindustry/niapiphp

v1.1.14 2016-01-14 21:12 UTC

README

这是最新行业API PHP SDK。

基本实现

您可以通过在require部分使用以下命令通过composer加载类:

"newestindustry/niapiphp": "dev-master"

in

之后,您可以向默认对象提供client id、client secret和redirect uri来初始化NI类

$config = array(
                "client_id" => "clientid", 
                "client_secret" => "clientsecret",
                "redirect_uri" => "http://redirect/uri"
            );
$ni = new \NI($config);

并通过调用login()函数启动登录过程。

$ni->login();

确保在启动会话之后执行此操作。使用的会话名称空间是"niapi"。

如果您想将用户重定向到注册表单而不是登录表单,请将注册标志设置为true。

$ni->login(true);

这将直接将用户带到注册表单。注册后,用户将被重定向到登录表单,一切将按相同的方式工作。

之后,oauth令牌存储在会话中,现在将自动在未来的任何调用中使用。如果您想获取登录用户的配置文件,您可以使用预定义的配置文件调用或直接使用API调用。

$profile = $ni->getApi()->get("/me/");

这将返回\NI\Api\Response对象。实际的用户配置文件数据将在

$profile->data->me;

中,但作为辅助工具,getProfile可用

$profile = $ni->getApi()->getProfile();

它可以是false,或者用户对象。

侧边栏

要加载NI侧边栏,您可以使用Sidebar组件类

$sidebar = \NI\Components\Sidebar();

由于可爱的魔法__string函数,这可以直接在模板或代码中使用

echo $sidebar;

配置选项

描述 默认值 可能值
base_url API端点URL "https://api.newestindustry.nl" 有效的URL
client_id oauth的客户端ID false 有效的客户端ID
client_secret oauth的客户端密钥 false 有效的客户端密钥
redirect_uri 登录后要重定向到的URL false 有效的重定向URI
scope 数据作用域 "default" "default"
api_key API密钥 false 有效的API密钥