v3/user/is_login

目录

1 功能说明

验证用户的登录态,判断openkey是否过期,没有过期则对openkey有效期进行续期(一次调用续期2小时)。


本接口的调用场景:
(1) 用来验证用户登录态。
验证登录态的必要性详见这里:技术优化原则#1.3 需要考虑对登录态做校验
(注:如果是多区多服应用,除调用本接口进行登录态验证外,还需要调用v3/user/is_area_login接口验证是否从选区页面进入应用)。

(2) 用来对openkey进行续期。
用户登录平台后进入应用时,URL中会带有该用户的OpenID和openkey,该openkey具有2小时的有效期。如果用户在应用中一直在操作,但是2小时内没有触发OpenAPI的调用,则会导致openkey过期。
因此开发者需要调用本接口来对openkey进行续期,一次调用续期2小时。本接口无调用次数限制。
注:1.如果由于平台统一刷新登录态导致续期机制失效,开发者可调用fusion2.dialog.relogin接口弹出登录弹框让用户登录,重新获得openkey。
2.openkey的最大可续期间隔为2小时,最大有效期是12-24小时,每天的早晚8点为集中过期时间。集中过期规则如下:以早晚8点为参考时间点,超过12小时的openkey全部失效。如,今天上午10点拿到的openkey,到今天晚上8点第一个集中过期时间点判断时,因不足12小时故不会过期;而到明天上午8点第二个集中过期时间点判断时,已超过12小时,因此从这个时刻起就过期了。

2 接口调用说明

2.1 URL

http://[域名]/v3/user/is_login

正式环境域名或测试环境IP详见:API3.0文档#请求URL说明

2.2 格式

json

2.3 HTTP请求方式

GET, POST

2.4 IP限制

TRUE

2.5 输入参数说明

各个参数请进行URL 编码,编码时请遵守 RFC 1738

(1)公共参数
发送请求时必须传入公共参数,详见公共参数说明

(2)私有参数
无。

2.6 请求示例

http://113.108.20.23/v3/user/is_login?
openid=B624064BA065E01CB73F835017FE96FA&
openkey=5F154D7D2751AEDC8527269006F290F70297B7E54667536C&
appid=2&
sig=9999b41ad0b688530bb1b21c5957391c&
pf=qzone&
format=json&
userip=112.90.139.30

2.7 返回参数说明

参数名称 描述
ret 返回码。详见公共返回码说明#OpenAPI V3.0 返回码
msg 如果错误,返回错误信息。

2.8 正确返回示例

JSON示例:

Content-type: text/html; charset=utf-8
{
"ret":0,
"msg":"用户已登录"
}

2.9 错误返回示例

Content-type: text/html; charset=utf-8
{
"ret":1002,
"msg":"用户没有登录态"
}

以上信息是否解决您的问题?

Copyright © 1998 - 2018 Tencent. All Rights Reserved.

腾讯公司 版权所有

有问必答 返回顶部