Rest API概述

请求地址

REST完整请求地址由Base URL与业务URL相拼接构成。

Base URL如下:

http://paasopen.ucc360.com/paas_open/

业务URL与具体的业务相关。格式统一如下

/{ category }/{ account }/{ func }? sign ={ sign }

业务URL中个字段含义如下:

字段名称 字段类型 约束限制 含义说明
category String 必填 目前支持base和misc。其中base为简单的基础接口,misc为相对复杂的业务接口。当前接口为base基础接口
account String 必填 账户ID,PAAS平台提供,现提供测试账户tdlxtest
func String 必填 接口名称
sign String 必填 访问签名。访问签名的生成规为:MD5(账号ID+访问授权码+系统当前时间戳),时间戳为标准的Unix时间戳(即从1970年1月1日距今的毫秒数,账户ID同上,授权码PAAS平台提供) ,其中MD5加密为32位。现提供测试访问授权码token为tdlxtesttoken

请求包头

在进行接口访问前,需要设置HTTP的请求包头。HTTP必填包头字段如下:

Accept : application/json;
Content-Type : application/json; charset=utf-8;
Authorization : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

包头中个字段含义如下:

字段名称 字段类型 约束限制 含义说明
Accept String 必填 客户端响应接收数据格式。当前支持:application/json
Content-Type String 必填 请求数据类型,当前支持:application/json;charset=utf-8;
Authorization String 必填 认证信息:Base64编码(账户Id + 冒号 + 时间戳)。时间戳为标准的Unix时间戳(即从1970年1月1日 距今的毫秒数)

请求包体

请求包体为业务参数拼装成的json格式字符串,以post提交。

{ "key1" : "value1", key2" : "value2" }

响应结果

响应结果为json格式字符串

{ "code" : "200" , " msg" : null , "data" : {" key1" : "value1"}}

属性 类型 约束 说明
code String 必选 请求状态码,成功200,错误码可参考Rest 错误代码。
msg-Type String 可选 错误原因描述
data String 必选 调用成功返回的数据

Rest API简介

通信PAAS平台接口向第三方开放,以满足第三方通信上的开发需求。

接口基于http协议,采用post方式提交,数据支持json格式规范。第三方需要登陆PAAS平台注册账号,以获取接口访问的授权码。

REST API提供功能如下:

API是基于rest协议的,您可以使用几乎任何客户端在任何编程语言与REST API进行交互,以及编写和测试应用程序。