# 企业内部应用免登

# 获取jsapi_ticket

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称
地址 /get_jsapi_ticket?access_token=ACCESS_TOKEN
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 应用的唯一凭证

【注意】正常情况下access_ticket有效期为7200秒。

(1)当jsapi_ticket未过期时,再次调用get_jsapi_ticket会续期7200秒。

(2)jsapi_ticket是一个appKey对应一个,所以在使用的时候需要将jsapi_ticket,以appKey为维度进行缓存下来(设置缓存过期时间2小时),并不需要每次都通过接口拉取。

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "access_ticket": "fw8ef8we8f76e6f7s8df8s12312312",
        "expired_time" : "1576835930"
    }
}

# JsApi验证sign

# 概述

名称
地址 /jsapi/sign
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
token String 客户端token, 放到header key是 AUTHORIZATION
app_id String 应用app_id
corp_id String corp_id企业唯一标识
time_stamp String time_stamp时间戳
nonce_str String nonce_str签名随机字符串
url String 当前页面的url 当前网页的URL,不包含#及其后面部分
signature String signature签名

# 注意事项:

  • app_id(agent_id)、time_stamp、nonce_str是业务方后端放回给前端的。
  • url参数必须是前端获取到当前页面的url,请求通用组件js_config的时候传递给业务方后端,业务方后端一定要将url url_decode()后生成签名
  • 在签名验证时候客户端会获取页面url,客户端一定要将url进行decode,这样才能确保生成签名和验证签名的url完全一样。

jsTicket 获取方式获取jsapi_ticket

signature计算方式:(PHP代码示例)

function getSignature($jsTicket, $nonceStr, $timeStamp, $url)
{
    $plain = 'jsapi_ticket=' . $jsTicket .
        '&noncestr=' . $nonceStr .
        '&timestamp=' . $timeStamp .
        '&url=' . $url;
    return sha1($plain);
}

返回值

{
    "code": 200,
    "msg": "",
    "obj": {

    }
}
{
     "code":"错误code码" ,
     "msg":"错误信息",
     "obj": {

     }

}

# 客户端联调接口-生成免登码

# host: https://yach-capi.zhiyinlou.com 正式环境

# host: https://yach-capi-test.zhiyinlou.com 测试环境

# 概述

名称
地址 /ucenter/auth/code
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
AUTHORIZATION String 客户端token, 放到header key是 AUTHORIZATION

【注意】正常情况下code只能使用一次,并且有效期为5分钟。

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "code": "8QPJOxPwffBGn4uMPp1cFk3uNphxZJjFur4zwNXcfn8dOvQig3jArcAQoNJIM8IeMPFNlrdSDUmu2PFZ1KFnoTqV86zrhqi8nD8su2HAAMU="
    }
}

返回值说明:

参数 说明
code 返回码
msg 对返回码的文本描述内容
obj 返回数据
code 免登码

# 免登code码获取用户基本信息

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称
地址 /user/getuserinfo?access_token=access_token
请求方式 POST
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 调用接口凭证
code String 免登授权码(免登code有效时间为5分钟且只能使用一次,5分钟内不使用将过期,重复使用将提示免登code不存在,一定要对code进行urlencode编码

【注意】正常情况下access_token有效期为7200秒,有效期内重复获取返回相同结果。

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "userid": "Yach076429",
        "corp_id": 1
    }
}

# 获取Yach管理后台当前管理员信息

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-test.zhiyinlou.com 测试环境

# 概述

名称
地址 /sso/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
请求方式 GET
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
access_token String 应用的唯一凭证
code String 通过Oauth认证给URL带上的CODE

【注意】正常情况下access_token有效期为7200秒,有效期内重复获取返回相同结果。

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "userid": "yach076421"
    }
}

返回值说明:

参数 说明
code 返回码
msg 对返回码的文本描述内容
obj 返回数据
userid 用户企业唯一标识id
上次更新: 11/9/2021, 12:27:37 PM
foo