API规范
- 所有API均以HTTP(S)方式提供。
- 所有GET方法的参数请以Query string方式提供。
- 所有POST方法的参数请以
"application/x-www-form-urlencoded"
(即表单提交)方式提供。 - 所有正确返回体均为JSON格式。
- 推荐开启gzip加快传输速度。
- 所有编码均为
UTF-8
。 - 所有请求都需要签名,签名方式见参数签名。
状态码定义
- API响应体状态码遵循HTTP标准,以下是可能出现的状态码,其中只有200为成功:
状态码 | 说明 |
---|---|
200 | 成功 |
400 | 参数不正确 |
401 | 参数签名不正确 |
405 | 方法不正确 |
500 | 业务错误 |
551 | 请求QPS限制,请限制QPS为10r/s |
服务器地址
环境 | 配置 |
---|---|
测试 | https://openapibeta.piaoniu.com |
正式 | https://openapi.piaoniu.com |