获取access_token - xiaoetong/XiaoeOpenApiDemo GitHub Wiki

接口：

  • 调用该接口获取 access_token

简介

  • access_token 是小鹅开放api的全局唯一接口调用凭据，调用各接口时都需使用，开发者需要进行妥善保存

请求方式及url：

  • get

  • 请求接口https://api.xiaoe-tech.com/token

参数：

参数名 必选 类型 说明 备注（示例）
grant_type 是 string 获取access_token填写client_credential ...
app_id 是 string 店铺的业务id ...
secret_key 是 string 店铺的凭证秘钥 ...

返回示例

  • 正确示例
{
    "code": 0,
    "msg": "success",
    "data": {
        "access_token": "xe_5bbd78e51299f_TqVn8FQCYMZoGePgesAhvcBj10cIVIkfHwQFfCFyaypXHMfWk4uje4bX0K0dDBYPTouaDnYj7I2EzhgKg4FejcoHnZj9aTSA3PYOTeOcPnPVKJjqvfiEFh1SQGH10sTjbYyVutAuMxEHTABFQSjM6eFLDhXadBA",
        "expires_in": 7200
    }
}
  • 错误示例
{
    "code": 2001,
    "msg": "invalid secret_key",
    "data": null
}

返回参数说明

参数名 必选 类型 说明 备注
access_token 是 string 凭证 ...
expires_in 是 int 过期时间，单位秒 ...

补充说明

  1. access_token 的存储至少要保留512个字符空间。access_token的有效期目前为2个小时，需定时刷新，重复获取将导致上次获取的 access_token 失效。
  2. 建议店铺开发者使用中控服务器统一获取和刷新 access_token ，其他业务逻辑服务器所使用的 access_token 均来自于该中控服务器，不应该各自去刷新，否则容易造成冲突，导致access_token 覆盖而影响业务；
  3. 目前 access_token 的有效期通过返回的 expire_in 来传达，目前是7200秒之内的值。中控服务器需要根据这个有效时间提前去刷新新 access_token。在刷新过程中，中控服务器可对外继续输出的老 access_token，此时小鹅通后台会保证在5分钟内，新老 access_token 都可用，这保证了第三方业务的平滑过渡
  4. app_id 和 secret_key 联系客户经理获得。
  5. 调用接口时，请在小鹅通管理台提前将服务器的ip添加到白名单中，否则将无法调用成功。
  6. 获取 access_token 的接口调用是有频率限制的，该接口的频率是每日2000，超出请求次数该接口当天将拒绝提供服务

备注