使用Restclient工具验证Open API(仅限openid认证)
可以使用第三方工具Restclient来验证Open API接口。
- 在使用Restclient工具验证Open API前,请参考前期准备做好前期准备。
- 请确保客户端使用的协议版本与服务端一致,否则接口调用不通。服务端的协议版本配置,请参考修改配置文件。
- 由于Restclient工具自身的限制,在使用Restclient工具验证Open API前,请在服务端的“eSight安装目录/AppBase/etc/oms.ros/ros.xml”文件中添加ssl.protocol项(配置项路径为“webservers/rosOpenAPIROA/connectors/openapiROAConnector/ssl.protocol”),并重启服务端。
<property name="ssl.protocol" value="TLSv1.2" />
运行工具
在JAR包上单击鼠标右键,使用Java打开此程序。
需要运行环境已经安装了JRE。
获取openid
- 输入URL。
格式为https://IP:32102/rest/openapi/sm/session,其中IP是Open API服务所在机器的IP地址。如,https://10.66.69.188:32102/rest/openapi/sm/session。
- 在Method页签中选择“PUT”。
- 在Body页签中输入参数,参数填写方法可以参考登录eSight。
Body类型为“String body”,报文类型为“application/x-www-form-urlencoded; charset=UTF-8”。
body内容为“userid=llmtest&value=Test1234&ipaddr=10.66.69.182”,其中userid、value、ipaddr是参数名,在接口中有介绍。llmtest、Test1234、10.66.69.182是值。
- 在SSL页签的Truststore标签中输入证书路径和密码。
证书可以从网管获取,获取路径请参考配置文件ros.xml中ssl.keystore.path项的配置。
密码输入证书实际的密码,首次替换证书时,请联系华为技术支持工程师获取证书的默认密码。
- 在SSL页签的General标签中,设置如下。
- 单击右边的按钮
。
报文中的“367606819df8ea25ad5a9a9e5dd92fb286368c76504d1697”就是openid。
调用Open API功能接口
当Method页签中选择的方法为DELETE时,请将参数位置为“参数列表”的参数放在URL中,如http://10.66.69.188:32102/rest/openapi/user?userid=user01,否则接口会调用失败。
这里以查询设备信息的接口为例,其他接口的调用方法类似。
阅读查询设备信息的接口信息,可以获取到如下信息:
- URL:/rest/openapi/nedevice
- http方法:GET
- 部分参数信息如下:
参数名
必选/可选
参数位置
参数类型
参数说明
necategory
可选
URL参数列表
String
设备分类。
netype
可选
URL参数列表
String
设备类型。
neip
可选
URL参数列表
String
设备IP地址。
- 输入URL:https://10.66.69.188:32102/rest/openapi/nedevice。
- 在Method页签中选择“GET”。
- 在Headers页签中添加参数openid。
key为“openid”,value的值就是上面获取的openid值“367606819df8ea25ad5a9a9e5dd92fb286368c76504d1697”。
- 在SSL页签的Truststore标签中输入证书路径和密码。
证书可以从网管获取,路径可以参考配置文件ros.xml配置。
密码输入证书实际的密码。
- 在SSL页签的General标签中,设置如下。
- 单击右边的按钮
。