1 .概要
与SOAP相比,REST WebService简化了调用并降低了技能要求。
REST近年来已经成为最主要的Web服务设计模式。 事实上,REST对Web的影响非常大,而且易于使用,因此它通常会取代基于SOAP和WSDL的接口设计。
您可以按照说明启动HTTP请求,而无需知道REST是什么。 请遵循以下基本原则
1 REST用URL记述人员、部门、协同、公文等资源。
使用HTTP协议的GET、POST、PUT和DELETE描述资源的获取、创建、修改和删除。
请注意,所有REST服务都必须传递通过认证服务获取的token。 省略以下说明。
1.1 .启用rest风格的web服务
联合安装完成后,无法直接使用rest风格的web服务。 系统管理员必须登录系统,将rest用户添加到信息集成配置→ REST用户管理模块中才能启用。
系统管理员创建REST用户后,需要REST用户的资源批准,并且REST用户只能访问已授权的资源。
1.2 .配置开发环境
要启动服务并显示rest风格的web服务的WADL,请执行以下操作:
3358 IP : port/see yon/rest/application.wadl
例如http://127.0.0.133608080/see yon/rest/application.wadl
1.3 .验证服务
要使用创建的REST用户访问REST风格的web服务,必须首先验证并检索token。 所有服务必须提供有效的令牌ID才能启动。
为了确保安全性,认证服务必须使用POST方式,用户名和密码使用请求Body以JSON格式发送。
接口调用请求的说明
http请求方式: POST
3358 IP : port/see yon/rest/token
原始的HTTP请求如下
post http://127.0.0.1/see yon/rest/token http/1.1
主机: 127.0.0.1
accept : APP/JSON
内容类型: APP/JSON
{'userName':'rest ',' password':'123456'}
请求实例:
3358 IP : port/see yon/rest/token/{ rest username }/{ password }
参数说明
参数
是否为必需
说明
用户名称
是
REST用户登录名
密码
是
REST用户密码
回到说明
成功返回JSON字符串,-1失败。
成功:
{ ' id ' : ' 013 a2a1e-a0b0- 4f 66-b533-da 0563 f 89 c6c ' }
失败:
{'id': '-1'}
1.3.1 .添加验证服务器当前注册者(Since:V6.0 )
确保服务接口可以绑定和设置当前OA登录人员。
接口调用请求说明:
请求示例:
3358 IP : port/see yon/rest/token/{ rest username }/{ password }? loginName={loginName}
或者
3358 IP : port/see yon/rest/token/{ rest username }/{ password }? memberCode={memberCode}
参数说明
参数
是否为必需
说明
用户名称
是
REST用户登录名
密码
是
REST用户密码
loginName
不
OA用户登录名
成员代码
不
OA用户代码,since 7.1
7.1之前需要loginName; 从7.1开始,选择loginName和memberCode中的一个参数即可。
回到说明
成功返回了JSON字符串。 找不到:页
成功:
{ '绑定用户' : ' . '
' id ' : ' 013 a2a1e-a0b0- 4f 66-b533-da 0563 f 89 c6c ' }
失败:
{'id': '-1'}
1.4.Token获取是否检查绑定IP (since : v 5.6 ) ) ) ) ) ) ) ) )。
创建新的REST帐户时,是否选中“是否获取Token并检查IP”,设置获取Token时是否检查当前请求的IP。
参数说明
参数
是否打勾
说明
获取token是否验证绑定IP
打勾
获取token时检查IP,如果与【绑定IP】设置不同,则无法获取token
获取token是否验证绑定IP
未勾选
不要求IP检查
1.5 .传递token
除了认证服务外,所有REST调用时都必须传递Token。 如果不传递Token或传递错误的Token,则会返回HttpStatus.SC_UNAUTHORIZED401错误和错误消息。
Token的生命周期为15分钟,如果15分钟没有调用,则Token无效。 禁用后,调用将返回401,并显示“Invalid token,please authenticate again”。
Token的传递方法有两种:
在HTTP请求的头中,使用token属性
get http://127.0.0.1/see yon/rest/XXX http/1.1
主机: 127.0.0.1
accept : APP/JSON
内容类型: APP/JSON; charset=UTF-8
用户代理: Mozilla/5.0 (windows nt 6.2; WOW64 ) appleWebKit/537.36(khtml,like Gecko ) chrome/32.0.1700.76 safari/537.36
cookie : jsessionid=5079 b8d c8 a4 BD 52e 48 FBA 4d e78 C2 a43 c
token:xxxxx
xx
2按请求参数传递,例如
http://127.0.0.1/see yon/rest/org member/123? token=