北向API对接

调用说明

智能设施云平台应用侧（又名“北向”）提供了REST（Representational State Transfer）风格API，支持您通过HTTPS请求调用。

约束与限制

• 您能创建的资源的数量与配额有关系。
• 更详细的限制请参见具体API的说明。

基本概念

• 用户

  在设施aPaaS中创建的用户，是设施aPaaS平台的使用人员，具有身份凭证（密码）。

  通常在调用API的鉴权过程中，您需要用到用户名和密码信息。

  拿到对应项目的设施云前端用户和密码后登录到设施云前端页面后，参考下面步骤创建一个机机账号用于对接API接口：

  1、找到账号管理菜单下的用户管理，单击“创建用户”，账号类型要选择机机账户，邮箱和联系电话填写一个。

  图1 创建机机账号
  

  2、单击“确定”成功后会弹出下面提示，继续单击“确认”。

  图2 确认页面
  

  3、接着会跳转到编辑用户页面，为该用户的角色选择“te_admin”后单击“确定”，这样一个机机账号就创建完成了，后面调用生成token接口请求体里面name字段值对应本次机机账号的用户名，password字段值对应本次机机账号的密码。

  图3 绑定角色
  

• 实例

  客户开通设施aPaaS后，对应开通一个实例。设施aPaaS核心资源（包括用户）存储都在实例下，不同实例的资源相互独立，不支持跨实例类型的资源。在API中不同实例对应的实例ID不同，登录设施云前端成功后，可以鼠标放在右上角的用户后出现查看实例信息单击，就可以获取到当前用户的实例ID，实例ID对应的就是API接口中请求头的X-Instance-Id这个字段（通常不同的交付局点对应这个实例ID不同）。

  图4 查看实例信息
  
• 项目

  设施云针对不同的项目做了二级资源隔离（比如在不同项目下创建的设备只能在该项目中查看对应项目的设备）。在设施云前端登录成功后，可以在“系统管理-》项目管理”菜单下查看当前用户的所有项目，如下图所示：

  图5 查看项目列表
  

  单击对应项目详情就可以查看对应项目的项目ID，项目ID对应的就是API接口中请求头的X-Root-Zone-Id这个字段。也可以通过查看API文档中项目管理下的查询项目列表接口获取对应项目ID。

  图6 查看项目ID