Open API调用说明
1.1 Open API调用说明
1.1.1 请求url说明
//[域名/IP]/[api_name]
域名和IP的说明：正式环境下使用域名：openapi.tencentyun.com。测试环境下使用IP：119.147.19.43
注：测试IP只能用于应用测试环境，应用部署前必须确保已经将程序中的测试IP换成了域名，才能将应用上线到正式环境。
请求URL的示例：
正式环境下访问OpenAPI V3.0：
//openapi.tencentyun.com/v3/user/get_info
测试环境下访问OpenAPI V3.0：
//119.147.19.43/v3/user/get_info
超时时间说明
OpenAPI一般会在50ms以内返回数据，OpenAPI接口机设置的最长超时时间为3s。
开发者可以根据上述说明自行设置OpenAPI调用的超时时间。
开发者可以根据上述说明自行设置OpenAPI调用的超时时间。
1.1.3 公共参数
| 参数名称 | 是否必须 | 参数含义 | 描述 |
|---|---|---|---|
| openid | 必须 | string | 见名词解释部分 |
| openkey | 必须 | string | 见名词解释部分 |
| appid | 必须 | unsigned int | 见名词解释部分 |
| sig | 必须 | string | 请求串的签名，以appkey作为密钥，具体签名算法见腾讯开放平台第三方应用签名参数sig的说明。 |
| pf | 必须 | string | 见名词解释部分 |
| format | string | 定义API返回的数据格式。 取值说明：为xml时表示返回的格式是xml；为json时表示返回的格式是json。 注意：json、xml为小写，否则将不识别。format不传或非xml，则返回json格式数据。 |
|
| userip | string | 指定请求及响应的字符集, 可选取值为gbk和utf-8, 默认值为gbk, 其他非法取值也认为是gbk |
1.1.4 公共返回码
ret = 0: 正确返回，其他情况为异常。
详见：OpenAPI V3.0 返回码
1.1.5 错误返回示例
数据结构如下：
{
"ret":1000002,
"msg":"您提交的参数不正确，请重新操作！",
"uin":0
}
不同的异常，错误码不同。
{
"ret":1000002,
"msg":"您提交的参数不正确，请重新操作！",
"uin":0
}
不同的异常，错误码不同。