Web服务接口
外部应用集成
#外部应用程序集成
## 网页服务
RSJ LPSNG提供以下Web服务:
*提交打印作业
##提交打印作业
| 参数 | 价值 |
|---|---|
| URL | / submit |
| 方法 | POST |
| 内容类型 | multipart / form-data |
| 标题 | 显示的职位描述 |
| 格式 | 布局ID |
| 数据 | 数据(CSV,JSON,XML或Excel) |
| 回调 | 可选的JSONP回调 |
| 组oauth_token | OAuth2访问令牌(如果未在OAuth方案中的授权HTTP标头中指定) |
##身份验证 RSJ LPSNG使用标准OAuth2协议为多个用户安全地集成多个独立的外部应用程序。
RSJ LPSNG使用此身份验证作为其路由决策的基础
###外部申请注册
开发人员可以通过以下方式在线注册RSJ LPS NG的外部应用程序:
- 应用名称 *申请说明 *应用程序图标 *应用程序重定向URL
他们将收到:
*申请ID *应用秘密
###外部应用程序授权
最终用户可以在线授权外部应用程序以在其行为上使用RSJ LPS NG。
####最终用户视图
1.用户单击外部应用程序中的链接,将其重定向到RSJ LPSNG登录(如果尚未登录),然后再转到RSJ LPS NG授权屏幕 2.如果用户接受应用程序链接,则将其重定向回存储验证信息的外部应用程序。
####外部应用程序视图
外部应用程序通过重定向提供以下信息:
*申请ID(在申请注册期间分配) *回调URL(在申请注册期间指定) *可选的上下文信息(用于回调)
| 参数 | 价值 |
|---|---|
| 网址 | / authorize |
| 方法 | GET |
| client_id | 客户ID(来自申请注册) |
| response_type | 代码 |
| 范围 | 满 |
| redir_uri | 重定向URI(必须与应用程序注册中的URI匹配) |
| 州 | 回调的可选上下文信息 |
成功授权后,最终用户会话将使用以下参数重定向到外部应用程序:
*上下文信息(来自重定向) *临时授权码(有效期10分钟)
外部应用程序通过提供以下内容来调用Web服务以使用永久刷新令牌交换临时授权:
*临时授权码 *申请ID *应用秘密 *回调网址
外部应用程序永久存储最终用户的刷新令牌
| 参数 | 价值 |
|---|---|
| URL | / auth |
| 方法 | POST |
| grant_type | refresh_token |
| refresh_token | 刷新令牌(来自应用程序授权) |
| 返回 | JSON结构 |
###外部应用程序请求
在为最终用户访问RSJ LPSNG之前,外部应用程序必须将刷新令牌交换为临时(60分钟)有效访问令牌。 它调用web服务:
*刷新令牌
它收到:
*临时(60分钟)访问令牌
外部应用程序在其Web服务请求中包含此访问令牌(在Auth HTTP标头中或作为参数)
RSJ LPSNG将访问令牌与外部应用程序和最终用户相关联。
访问令牌可能在任何时候(甚至在它过期之前)变为无效。在这种情况下,返回401错误,外部应用程序必须在重试失败请求之前检索新的访问令牌。
| 参数 | 价值 |
|---|---|
| URL | / auth |
| 方法 | POST |
| grant_type | authorization_code |
| 代码 | 授权码(来自重定向) |
| client_id | 客户ID(来自申请注册) |
| client_secret | 客户秘密(来自申请注册) |
| refresh_token | 刷新令牌(来自应用程序授权) |
| 返回 | JSON结构 |
