这里会显示出您选择的修订版和当前版本之间的差别。
|
开发实例 [2017/04/13 13:30] admin |
开发实例 [2017/08/23 08:44] |
||
|---|---|---|---|
| 行 1: | 行 1: | ||
| - | ====== REST demo介绍 ====== | ||
| - | **Demo 示例下载** | ||
| - | <html> | ||
| - | <div style="background-color: #d9edf7;border-color: #bce8f1;color: #31708f;padding: 10px;">官方开发实例下载 </div> | ||
| - | </html> | ||
| - | * java | ||
| - | * {{ucs_java_demo_v1.0.2.rar|下载：ucs_java_demo_v1.0.2}} | ||
| - | |||
| - | * php | ||
| - | * {{ucs_php_demo_v1.0.2.zip|下载: ucs_php_demo_v1.0.2}} | ||
| - | * [[php_rest|使用说明]] | ||
| - | |||
| - | * C# | ||
| - | * {{download:ucs_c_demo_v1.0.1.rar|下载: ucs_c_demo_v1.0.1}} | ||
| - | |||
| - | * python | ||
| - | * {{download:ucs_python_demo_v1.0.2.rar|下载: ucs_python_demo_v1.0.2.rar}} | ||
| - | |||
| - | <html> | ||
| - | <div style="background-color: #d9edf7;border-color: #bce8f1;color: #31708f;padding: 10px;">第三方开发者 </div> | ||
| - | </html> | ||
| - | |||
| - | |||
| - | * @hardywen [[https://github.com/hardywen/ucpaas-sms|php github]] | ||
| - | * @gongzili456[[https://github.com/topdmc/ucpaas|nodejs]] | ||
| - | | ||
| - | **请求地址** | ||
| - | |||
| - | <code> | ||
| - | /{SoftVersion}/Accounts/{AccountSid}/{function}/{operation}?sig={SigParameter} | ||
| - | </code> | ||
| - | |||
| - | ^属性 ^类型 ^约束 ^说明 | | ||
| - | |SoftVersion |String |必选 |云之讯REST API版本号，当前版本号为：2014-06-30 | | ||
| - | |AccountSid |String |必选 |开发者账号ID。由32个英文字母和阿拉伯数字组成的开发者账号唯一标识符 | | ||
| - | |SigParameter |String |必选 |请求URL必须带有此参数。 | | ||
| - | |Accept |String |必选 |客户端响应接收数据格式：application/xml、application/json | | ||
| - | |Content-Type |String |必选 |类型：application/xml;charset=utf-8、application/json;charset=utf-8 | | ||
| - | |Authorization |String |必选 |验证信息。 | | ||
| - | |function |String |可选 |业务功能。 | | ||
| - | |operation |String |可选 |业务操作，业务功能的各类具体操作分支。 | | ||
| - | |||
| - | |||
| - | **说明** | ||
| - | |||
| - | 1. SoftVersion是当前使用的REST API版本号，开发时须填写正确的版本号。 | ||
| - | |||
| - | 2. SigParameter是REST API验证参数\\ | ||
| - | * 普通列表项目URL后必须带有sig参数，sig= MD5（账户Id + 账户授权令牌 + 时间戳），共32位(注:转成大写) \\ | ||
| - | * 使用MD5加密（账户Id + 账户授权令牌 + 时间戳），共32位。 \\ | ||
| - | * 时间戳是当前系统时间（24小时制），格式"yyyyMMddHHmmss"。时间戳有效时间为50分钟。 | ||
| - | |||
| - | 3. Authorization是包头验证信息\\ | ||
| - | * 使用Base64编码（账户Id + 冒号 + 时间戳） \\ | ||
| - | * 冒号为英文冒号 \\ | ||
| - | * 时间戳是当前系统时间（24小时制），格式"yyyyMMddHHmmss"，需与SigParameter中时间戳相同。 | ||
| - | |||
| - | 4. function描述对应业务能力，operation描述业务能力的具体操作。例如：/Calls/voiceCode | ||
| - | |||
| - | <html> | ||
| - | <div style="background-color: #d9edf7;border-color: #bce8f1;color: #31708f;padding: 10px;">数据报文格式 </div> | ||
| - | </html> | ||
| - | ---- | ||
| - | |||
| - | |||
| - | REST API支持两种主流的报文格式：XML和JSON。 | ||
| - | |||
| - | 通过请求包头的字段Content-Type及Accept，即可决定请求包体和响应包体的格式，如： | ||
| - | |||
| - | <code java>Content-Type:application/xml;charset=utf-8;Accept:application/xml;</code> | ||
| - | |||
| - | 表示请求类型格式是XML，要求服务器响应的包体类型也是XML； | ||
| - | |||
| - | <code java>Content-Type:application/json;charset=utf-8;Accept:application/json;</code> | ||
| - | |||
| - | 表示请求类型格式是JSON，要求服务器响应类型也是JSON； | ||
| - | |||
| - | ----- | ||
