1. 接入须知

销赞云开放平台API的请求结构由:服务地址、通信协议、请求方法、请求头部、请求参数和字符编码组成。具体描述如下:

1.1. 服务地址

销赞云开放平台API的服务接入地址:https://openapi.xiaozancloud.com

1.2. 通信协议

所有接口通过 HTTPS 进行通信

1.3. 请求方法

同时支持 POST 和 GET 请求。

  • POST 和 GET 请求不能混合使用,若使用 GET 方式,则参数均从 Querystring 取得;若使用 POST 方式,则参数均从 Request Body 中取得,而 Querystring 中的参数将忽略。
  • 两种请求方式的参数格式规则相同,除了接口指定需要POST请求外,一般情况下可以使用 GET 请求,当参数字符串过长时推荐使用 POST。
  • 如果用户的请求方法是 GET,则对所有请求参数值均需要做 URL 编码,若为 POST,则无需对参数编码。
  • GET 请求的最大长度根据不同的浏览器和服务器设置有所不同,对于一些参数较多、长度较长的API,使用POST方法可以避免字符串超过最大长度而导致请求失败。
  • 对于 POST 请求,Content-Typex-www-form-urlencoded的传参。

1.4. 请求参数

每个请求都需要指定两类参数:请求头部以及接口请求参数。其中请求头部参数是每个接口都要用到的签名验证参数,而接口请求参数是各个接口所特有的,具体见各个接口的“请求参数”描述。

1.4.1. 公共头部参数

参数名称 参数类型 是否必须 示例 备注
clientId string 48ca17b00473d5ec95bbd4f9f24e651f clientID
accessToken string 46a9d6f4737342b963b923343522c568bd2f718cfaeb968002b615d602676382389ba9f050d531d1 access token
timestamp int 1632457757 UNIX时间戳,不能与服务器时间相差60分钟
nonce string 23421832 自定义随机数,5~10个字符,防重放
signature string n9DfIImvrm4tAwsqOY4cLIkLfkE= 签名串,用于保证请求的合法性,防篡改
signatureMethod string HmacSHA1 签名算法,HmacSHA1或HmacSHA256

1.5. 请求签名

除上传相关接口使用独立的签名验证方法,一般接口均使用相同的签名方法,见请求签名

results matching ""

    No results matching ""