获取AccessToken

本接口用户获取请求业务API时需要提供的accessToken信息，详情参见开发指南 -> 数据交互部分。

提示

CASP提供了2个接口获取AccessToken，请根据实际情况进行选择。

注意

开发者需要缓存accessToken，用于后续接口的调用（注意：不能频繁调用accessToken接口，否则会受到频率拦截）。当accessToken失效或过期时，需要重新获取。 accessToken的有效期正常情况下为7200秒（2小时），有效期内重复获取返回相同结果，过期后获取会返回新的accessToken。 由于每个应用的accessToken是彼此独立的，所以进行缓存时需要区分应用来进行存储。accessToken至少保留512字节的存储空间。

方式一(推荐) 3.4.1+

接口说明

请求URL：http[s]://[网关地址]/token/gateway/accessToken

请求方式： GET

请求内容类型： application/x-www-form-urlencoded

响应内容类型： application/json

请求说明

请求头

字段名	参数名	必填	类型	描述
应用ID	appId	M	String(128)	接入网关的应用ID
应用密钥	appSecret	M	String	接入网关的应用密钥

appId与appSecret获取方式参见概述部分。

提示

公共请求头参数在本接口中不适用。

请求示例

GET http[s]://[网关地址]/token/gateway/accessToken HTTP/1.1
appId: 111111111111111
appSecret: 18CDHNJBB6728263t

响应说明

响应体

字段名	参数名	必填	类型	描述
错误码	errcode	M	String	为0表示成功，非0表示调用失败
错误描述	errmsg	M	String	错误码对应描述信息
凭证信息	data	+M	String	获取到的凭证，即accessToken

响应示例

正确

{
  "errcode": "0",
  "errmsg": "本次生成的Token有效期为:120分钟",
  "data": "a05cb7c3aebc023a552e048868bf9e86"
}

异常

{
  "errcode": "997",
  "errmsg": "appId不存在"
}

Demo

java

// 创建客户端
Client client = new DefaultClient(BASE_URL, APP_ID, APP_SECRET);
// 创建请求对象
TokenGatewayAccessTokenRequest request = new TokenGatewayAccessTokenRequest();
request.setAppId(APP_ID);
request.setAppSecret(APP_SECRET);
Response response = client.execute(request);
//调用成功，则处理业务逻辑
if (response.isSuccess()) {
  //.....
}

方式二 3.4.1-

接口说明

请求URL：http[s]://[网关地址]/token/gateway/{appId}/accessToken

请求方式： GET

请求内容类型： application/x-www-form-urlencoded

响应内容类型： application/json

请求说明

请求头

字段名	参数名	必填	类型	描述
应用密钥	appSecret	M	String	接入网关的应用密钥

路径参数

字段名	参数名	必填	类型	描述
应用ID	appId	M	String(128)	接入网关的应用ID

appId与appSecret获取方式参见概述部分。

提示

公共请求头参数在本接口中不适用。

请求示例

GET http[s]://[网关地址]/token/gateway/111111111111111/accessToken HTTP/1.1
appSecret: 18CDHNJBB6728263t

响应说明

响应体

字段名	参数名	必填	类型	描述
错误码	errcode	M	String	为0表示成功，非0表示调用失败
错误描述	errmsg	M	String	错误码对应描述信息
凭证信息	data	+M	String	获取到的凭证，即accessToken

响应示例

正确

{
  "errcode": "0",
  "errmsg": "本次生成的Token有效期为:120分钟",
  "data": "a05cb7c3aebc023a552e048868bf9e86"
}

异常

{
  "errcode": "997",
  "errmsg": "appId不存在"
}

Demo

java

// 创建客户端
Client client = new DefaultClient(BASE_URL, APP_ID, APP_SECRET);
// 创建请求对象
TokenGatewayAccessTokenOldRequest request 
        = new TokenGatewayAccessTokenOldRequest();
request.setAppId(APP_ID);
request.setAppSecret(APP_SECRET);
Response response = client.execute(request);
//调用成功，则处理业务逻辑
if (response.isSuccess()) {
  //.....
}