当用户授权成功并跳转回到https://lexiangla.com/suites/auth-callback
,乐享会使用授权码换取用户ID。
以下接口均由乐享服务器发起请求,若需判断请求来源IP,参考可信IP
此接口由A企业按以下标准实现,由乐享服务器发起请求
假设A企业在乐享管理后台配置的获取用户信息接口如下:https://example.com/get_user_info
请求URL
POST https://example.com/get_user_info?code={CODE}
请求头
参数 | 是否必须 | 说明 |
---|---|---|
Content-Type | 是 | 固定值:"application/x-www-form-urlencoded" |
其他说明
事项 | 说明 |
---|---|
超时设置 | 此接口需在3秒内正确响应,超时将提示用户登录失败 |
请求参数说明
参数 | 是否必须 | 说明 |
---|---|---|
code | 是 | A企业生成的授权码,可获取登录成员信息。 query和body会同时存在code参数,目的是兼容部分加密算法会产生url特殊字符,body中的code参数是经过urldecode的,query是未经过urldecode的。开发者可自行根据实际情况读取参数 |
access_token | 否 | A企业提供接口调用凭证,由获取凭证接口返回 若企业未在乐享管理后台配置获取凭证接口,则不发送此参数 |
curl 请求示例
curl -X POST 'https://example.com/get_user_info?code={CODE}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'code={CODE}' \
--data-urlencode 'access_token={ACCESS_TOKEN}'
响应
返回 200 HTTP状态码,json响应结构如下(json结构内多出字段不影响)
{
"id": "zhangsan"
}
响应参数说明
参数 | 是否必须 | 说明 |
---|---|---|
id | 是 | 用户ID。对应乐享通讯录的员工帐号,可参考创建成员接口中的staff_id 字段 |
此接口是可选配置,仅作为获取用户信息接口前置接口调用。若需要对接,由A企业按以下标准实现,由乐享服务器发起请求
假设A企业在乐享管理后台配置的获取凭证接口如下:https://example.com/get_access_token?app_key=12&app_secret=34
请求URL
GET https://example.com/get_access_token?app_key=12&app_secret=34
其他说明
事项 | 说明 |
---|---|
超时设置 | 此接口需在3秒内正确响应,超时将提示用户登录失败 |
curl 请求示例
curl 'https://example.com/get_access_token?app_key=12&app_secret=34'
响应
返回 200 HTTP状态码,json响应结构如下(json结构内多出字段不影响)
{
"expires_in": 7200,
"access_token": "XXXXXXXXX"
}
响应参数说明
参数 | 是否必须 | 说明 |
---|---|---|
expires_in | 是 | 凭证有效时间(单位:秒),乐享侧会基于该值做缓存,且缓存时间不会大于1800秒 |
access_token | 是 | A企业的接口调用凭证 |