授权说明
1、用户使用appKey和appSecret，获取code
http://openapi.hspcn.com/Supply/Token/GetTestCode
- 提示：请用post分别传参，请勿将参数拼到地址后面，不要使用&拼接参数
- 入参1【appKey】：由平台提供
- 入参2【appSecret】：由平台提供
- 返回格式:其中Result的值就是要获取的code
"Result": "48697b8096b52849e75cd7de571523d5",
"Success": "200",
"Time": "20191021150523189",
2、使用code获取令牌token
http://openapi.hspcn.com/Supply/Token/GetTokenByCode
- 提示：请用post分别传参，请勿将参数拼到地址后面，不要使用&拼接参数
- 入参1【appKey】：由平台提供
- 入参2【code】：步骤【用户使用appKey和appSecret，获取code】获取的值
- 返回令牌 GetTokenByCode返回结果：其中AccessToken为令牌
"AccessToken": "8795258a-6c8f-43a5-b8d0-763631edb610",
"RefreshToken": "8795258a-6c8f-43a5-b8d0-763631edb610",
"RefreshExpires": "2016/12/30 8:59:52",
"AccessExpires": "2016/12/30 8:59:52",
"Success": 200
3、发起访问，以连通性测试为例
http://openapi.hspcn.com/Supply/01/S0100
- 提示：请用post分别传参，请勿将参数拼到地址后面，不要使用&拼接参数
- 入参1【access_token】：获取到的token值
- 入参2【name1】：此参数根据具体接口而定
- 入参3【name2】：此参数根据具体接口而定
- 入参4【jsonVal】：json字符串，比如 [{"a1":"张三","a2":"李四"},{"a3":"王五"}]，此参数根据具体接口而定
- 返回结果示例：
"Msg": "消息值",
"Result": { },
"Success": "200",
4、C#示例代码，java等其他语言以此类推
-
public static void Test()
{
string url = "http://thothinfo.gicp.net:28109/Supply/01/S0100";
System.Collections.Specialized.NameValueCollection parms = new System.Collections.Specialized.NameValueCollection();
parms.Add("access_token", "获取到的token值");
parms.Add("name1", "此参数根据具体接口而定");
parms.Add("name2", "此参数根据具体接口而定");
parms.Add("jsonVal", "[{\"a1\":\"张三\",\"a2\":\"李四\"},{\"a3\":\"王五\"}]");
//json形式的字符串 [{"a1":"张三","a2":"李四"},{"a3":"王五"}] ，整个json当做一个字符串参数传到后台，系统获取到jsonVal这个参数值后会自行解析成json数据，注意【jsonVal】这个名字随接口而定
//请用post分别传参，请勿将参数拼到地址后面，不要使用&拼接参数
System.Net.WebClient wCient = new System.Net.WebClient();
wCient.Headers.Add("Content-Type", "application/x-www-form-urlencoded");
byte[] responseData = wCient.UploadValues(url, "POST", parms);
string returnStr = System.Text.Encoding.UTF8.GetString(responseData);//返回接受的数据
}
常见问题
返回状态编码如下
- 200 成功
- 400 接口暂停使用
- 404 接口不存在
- 405 出错
- 406 参数错误
- 407 数据不存在
- 408 appkey和appSecret不存在
- 409 匿名接口次数超出
- 410 匿名接口频率过快
- 411 接口次数超出
- 412 接口频率过快
- 413 appkey和appSecret次数超出
- 414 appkey_token_code次数超出
- 415 appkey_token_refresh次数超出成功
- 416 appkey_冻解中
- 420 接口方法不正确
- 503 服务停止
- 801 未授权
- 802 过期Code
- 803 过期RefreshToke
- 804 过期AccessToken
SDK使用说明
SDK使用方法(以.net为例)
1、获取临时令牌(跳到指定url获取临时令牌code)
HspClient.GetCode();
2、获取授权
var item = HspClient.GetTokenByCode(code);
3、重新获取授权
var token = HspClient.GetTokenByRefresh(item.RefreshToken);
4、调用api接口
var dic = new Dictionary<string, string>();
dic.Add("accessToken", token.AccessToken);
dic.Add("api接口参数名", api接口参数值);
var result = HspClient.GetApiResult(HspApi.XX接口.删除XX.ToEnum(), dic);
系统级输入参数
|
名称
|
类型
|
是否必须
|
描述
|
|---|
|
access_token
|
string
|
是
|
用户授权令牌
|
应用级输入参数
|
名称
|
类型
|
长度
|
是否必须
|
默认值
|
描述
|
|---|
返回结果
|
名称
|
类型
|
描述
|
|---|
|
Success
|
Int
|
状态编码：详见常见问题
|
|
Msg
|
string
|
操作说明
|
|
名称
|
类型
|
长度
|
描述
|
|---|