“首页”的版本间的差异
来自uucall
| （未显示2个用户的2个中间版本） | |||
| 第1行： | 第1行： | ||
| − | ''' | + | <br /> |
| + | *<big><big>'''介绍'''</big></big> | ||
| + | UUCALL 云呼叫中心平台 REST API 接口是为企业用户提供CTI管理、接口拨号、语音插件管理、CRM管理、帐号权限管理、账户信息、文件管理等模块功能的外部控制及数据交互的接口支持。API是基于REST原则上的，所以它很容易编写和测试应用程序。您可以使用浏览器访问URL，也可以使用几乎任何客户端在任何编程语言与REST API进行交互。<br /><br /> | ||
| − | + | *<big><big>'''Base URL'''</big></big> | |
| − | + | <big><big>所有被引用的地址都有如下Base URL:</big></big><br /> | |
| − | + | 沙盒地址，用于应用上线前进行业务测试的Base URL：https://cloud.uucall.cloopen.com:8883<br /> | |
| − | * | + | 生产地址，用于应用上线后进行正式业务的Base URL：https://cloud.uucall.cn:3888<br /> |
| − | = | + | <br /> |
| − | + | 注意：平台的REST API是通过HTTP方式请求。 | |
| − | * | + | <br /> |
| − | + | *<big><big>'''统一请求包头'''</big></big> | |
| − | * | + | |
| − | * | + | <big><big>URL格式：</big></big>rest/{path}<br /> |
| + | 注意：在URL格式中rest为固定内容，{}内的内容表示为实际接口的路径。<br /> | ||
| + | |||
| + | <big><big>HTTP标准包头字段说明(必填)</big></big><br /> | ||
| + | Accept:text/xml;<br /> | ||
| + | Content-Type:text/xml;charset=utf-8;<br /> | ||
| + | Content-Length:256;<br /> | ||
| + | appid:XXXX<br /> | ||
| + | timestamp:2016-03-11 00:00:00<br /> | ||
| + | Authorization:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX<br /><br /> | ||
| + | <big><big>HTTP包头属性说明</big></big><br /> | ||
| + | appid: 对应模块应用id，具体详见appid获取接口说明<br /> | ||
| + | timestamp: 请求时间戳格式 yyyy-MM-dd HH:mm:ss<br /> | ||
| + | Authorization: 验证信息，生成规则详见下方详细说明<br /> | ||
| + | |||
| + | *<big><big>'''字段详细说明'''</big></big> | ||
| + | <big><big>1. appid 获取接口</big></big><br /> | ||
| + | • Accounts：主帐号鉴权，云通讯平台会对请求中的主帐号和主帐号Token进行验证。<br /> | ||
| + | • SubAccounts：子帐号鉴权，云通讯平台会对请求中的子帐号和子帐号Token进行验证。<br /><br /> | ||
| + | <big><big>2. SigParameter 鉴权参数</big></big><br /> | ||
| + | • SigParameter是隐藏参数，参与到 Authorization 的校验运算规则当中。<br /> | ||
| + | • 使用MD5加密（apikey+":"+extras+":"+timestamp）。其中apikey为企业授权接口密匙，需要接口使用者向UUCALL项目团队获取。<br /> | ||
| + | • 时间戳是当前系统时间，格式"yyyy-MM-dd HH:mm:ss"。时间戳有效时间为24小时，如：2014-04-16 14:20:30，且必须与HTTP字段时间戳一致。<br /> | ||
| + | • 所生成的 SigParameter参数为32位大写MD5值。<br /><br /> | ||
| + | <big><big>3. Authorization 包头验证信息</big></big><br /> | ||
| + | • 使用Base64编码（userName + 英文冒号 + SigParameter），其中 SigParameter 为隐藏数据。<br /> | ||
| + | • 冒号为英文冒号。<br /> | ||
| + | |||
| + | <br /> | ||
| + | *<big><big>'''返回值说明'''</big></big><br /> | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! HTTP Code !! 描述 !! 数据类型 | ||
| + | |- | ||
| + | | 200 || OK 请求成功 || 对应的结果返回值描述 | ||
| + | |- | ||
| + | | 401 || Unauthorizated 令牌授权失败 || No Content | ||
| + | |- | ||
| + | | 403 || Forbidden 访问禁止 || No Content | ||
| + | |- | ||
| + | | 405 || Method Not Allowed 方法未授权 || No Content | ||
| + | |- | ||
| + | | 410 || Gone 请求过期 || No Content | ||
| + | |- | ||
| + | | 424 || Failed Dependency 参数信息不合法 || No Content | ||
| + | |- | ||
| + | | 429 || Too Many Requests 请求过于频繁 || No Content | ||
| + | |- | ||
| + | | 500 || Internal Server Error 内部服务出错 || No Content | ||
| + | |} | ||
| + | <br /><br /> | ||
| + | *<big><big>'''数据报文格式'''</big></big> | ||
| + | 平台REST接口支持主流的报文格式：JSON。 | ||
| + | |||
| + | *<big><big>'''关于REST (REpresentational State Transfer)'''</big></big></br> | ||
| + | <nowiki> REST的客户端服务器分离理念大大简化了组件执行，降低了语义间连接的复杂度，改进了性能调整的有效性，增加了服务器组件的可扩展性。分层的结构化系统约束允许在不改变接口的情况下引入中间代理、网关、防火墙等多种接入点，并与之通讯，并且通过可扩展性，以共享内存的方式改进系统性能，有助于信息传递。通过对消息的约束，把REST的中间处理变为一个独立的自我描述：无状态交互，使用标准的方法和媒体类型。通过这种方式使语义信息，交互数据，响应信息能够明确的显示其使用缓存的能力。</nowiki> | ||
| + | |||
| + | <big><big>REST设计原则</big></big><br /> | ||
| + | 1. 应用场景和功能都被分为不同的资源<br /> | ||
| + | 2. 每一个资源通过一个全局的资源标识以超链接的方式被访问<br /> | ||
| + | 3. 所有资源通过共享标准的接口实现客户侧和资源之间的场景转换，资源包括如下两项：<br /> | ||
| + | • 已经被定义好的一套有约束的操作集。<br /> | ||
| + | • 一套有约束的内容类别集和可选的命令支持码。<br /><br /> | ||
| + | <big><big>REST 协议特点</big></big><br /> | ||
| + | • 客户侧请求服务器模式<br /> | ||
| + | • 状态无关<br /> | ||
| + | • 缓存机制<br /> | ||
| + | • 层次结构<br /><br /> | ||
2016年4月25日 (一) 13:55的最新版本
- 介绍
UUCALL 云呼叫中心平台 REST API 接口是为企业用户提供CTI管理、接口拨号、语音插件管理、CRM管理、帐号权限管理、账户信息、文件管理等模块功能的外部控制及数据交互的接口支持。API是基于REST原则上的，所以它很容易编写和测试应用程序。您可以使用浏览器访问URL，也可以使用几乎任何客户端在任何编程语言与REST API进行交互。
- Base URL
所有被引用的地址都有如下Base URL:
沙盒地址，用于应用上线前进行业务测试的Base URL：https://cloud.uucall.cloopen.com:8883
生产地址，用于应用上线后进行正式业务的Base URL：https://cloud.uucall.cn:3888
注意：平台的REST API是通过HTTP方式请求。
- 统一请求包头
URL格式：rest/{path}
注意：在URL格式中rest为固定内容，{}内的内容表示为实际接口的路径。
HTTP标准包头字段说明(必填)
Accept:text/xml;
Content-Type:text/xml;charset=utf-8;
Content-Length:256;
appid:XXXX
timestamp:2016-03-11 00:00:00
Authorization:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
HTTP包头属性说明
appid: 对应模块应用id，具体详见appid获取接口说明
timestamp: 请求时间戳格式 yyyy-MM-dd HH:mm:ss
Authorization: 验证信息，生成规则详见下方详细说明
- 字段详细说明
1. appid 获取接口
• Accounts：主帐号鉴权，云通讯平台会对请求中的主帐号和主帐号Token进行验证。
• SubAccounts：子帐号鉴权，云通讯平台会对请求中的子帐号和子帐号Token进行验证。
2. SigParameter 鉴权参数
• SigParameter是隐藏参数，参与到 Authorization 的校验运算规则当中。
• 使用MD5加密（apikey+":"+extras+":"+timestamp）。其中apikey为企业授权接口密匙，需要接口使用者向UUCALL项目团队获取。
• 时间戳是当前系统时间，格式"yyyy-MM-dd HH:mm:ss"。时间戳有效时间为24小时，如：2014-04-16 14:20:30，且必须与HTTP字段时间戳一致。
• 所生成的 SigParameter参数为32位大写MD5值。
3. Authorization 包头验证信息
• 使用Base64编码（userName + 英文冒号 + SigParameter），其中 SigParameter 为隐藏数据。
• 冒号为英文冒号。
- 返回值说明
| HTTP Code | 描述 | 数据类型 |
|---|---|---|
| 200 | OK 请求成功 | 对应的结果返回值描述 |
| 401 | Unauthorizated 令牌授权失败 | No Content |
| 403 | Forbidden 访问禁止 | No Content |
| 405 | Method Not Allowed 方法未授权 | No Content |
| 410 | Gone 请求过期 | No Content |
| 424 | Failed Dependency 参数信息不合法 | No Content |
| 429 | Too Many Requests 请求过于频繁 | No Content |
| 500 | Internal Server Error 内部服务出错 | No Content |
- 数据报文格式
平台REST接口支持主流的报文格式：JSON。
- 关于REST (REpresentational State Transfer)</br>
REST的客户端服务器分离理念大大简化了组件执行，降低了语义间连接的复杂度，改进了性能调整的有效性，增加了服务器组件的可扩展性。分层的结构化系统约束允许在不改变接口的情况下引入中间代理、网关、防火墙等多种接入点，并与之通讯，并且通过可扩展性，以共享内存的方式改进系统性能，有助于信息传递。通过对消息的约束，把REST的中间处理变为一个独立的自我描述：无状态交互，使用标准的方法和媒体类型。通过这种方式使语义信息，交互数据，响应信息能够明确的显示其使用缓存的能力。
REST设计原则
1. 应用场景和功能都被分为不同的资源
2. 每一个资源通过一个全局的资源标识以超链接的方式被访问
3. 所有资源通过共享标准的接口实现客户侧和资源之间的场景转换，资源包括如下两项：
• 已经被定义好的一套有约束的操作集。
• 一套有约束的内容类别集和可选的命令支持码。
REST 协议特点
• 客户侧请求服务器模式
• 状态无关
• 缓存机制
• 层次结构
