开始开发

获取 AppKey 和 AppSecret

  1. 以腾讯乐享管理员身份进入管理页

  2. 找到开发-基本配置,并点击进入(没找到?

  3. 进入后,点击初始化配置

  4. 此时会弹出二维码需要当前用户扫码登录确认管理员身份,扫码登录后,确定初始化

  5. 初始化成功会显示 AppSecret,请用户复制后妥善保存,切勿泄漏。关闭弹框后不在再显示 AppSecret

此时可从页面上看到 AppKey,在下一步获取 access_token 中会用到

获取 access_token

access_token 是第三方调用应用接口时的唯一凭证,开发者必须妥善保存。

access_token 目前有效时间为2小时,开发者需要缓存,避免频繁调用获取 access_token 接口导致超出频率限制被拦截。 可参考示例代码Lxapi.php的实现。

接口调用说明:

POST https://lxapi.lexiangla.com/cgi-bin/token

参数说明:

参数 是否必须 说明
grant_type 使用固定值 client_credentials
app_key 前面获取的 AppKey
app_secret 前面获取的 AppSecret

接口正常返回说明:

200 OK 状态码
{
  "token_type": "Bearer",
  "expires_in": 7200,
  "access_token": "XXXXXXXXX"
}
参数 说明
token_type Token 类型
expires_in 凭证有效时间,单位:秒
access_token 凭证

接口错误返回说明:

400 Bad Request 状态码

参数错误,如缺少必填参数,grant_type 错误等

404 Not Found 状态码

app_key 不存在

429 Too Many Requests 状态码

请求超出频率限制

使用 access_token

调用任何一个应用接口时,HTTP Header 都必须带上 access_token。

假设获取到的 access_token 为 beautiful_girl,那么设置格式如下:

Authorization: Bearer beautiful_girl

在请求应用接口时必须用有效的 access_token 设置好 Header,否则会返回 401 Unauthorized 错误。

设置 StaffID

一般写操作的接口都需要以某个员工的身份去请求,这个信息需在 HTTP Header 中设置。

StaffID: TX000001