v3/spread/verify_invkey

目录

1 功能说明

验证好友邀请的invkey,用于“邀请好友即赠送礼品”等场景。

平台提供了好友邀请前台接口(fusion2.dialog.invite),用户可以邀请好友添加应用。
当邀请成功并且被邀请对象开通应用后,平台会在CanvasURL(CanvasURL介绍详见这里)后加入三个参数 invkey , itime , iopenid,分别对应的含义是:
invkey 加密串
itime 邀请时间
iopenid 发起邀请者的openid
应用可以通过调用本接口来验证invkey,以此判断添加了该应用的用户是否是由某个用户邀请过来的,从而发起送礼等操作。

注意:
1. 只会在好友第一次进入应用时在CanvasURL后带上iopenid,invkey,itime等参数。
如果用户点击接受邀请,进入安装应用页面时,刷新了页面,后续再次进入应用时,不会再传入iopenid等参数。
2. 如果用户不是通过好友发送的邀请请求中的应用链接进入应用的,而是通过其它途径进入应用(例如自己在应用中心中搜索应用然后进入),也不会传入iopenid等参数。
3. 此函数在上线前无法调试成功,请在应用上线后调试。

本接口是全平台通用的。

2 接口调用说明

2.1 URL

http://[域名]/v3/spread/verify_invkey

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

2.2 格式

json

2.3 HTTP请求方式

GET, POST

2.4 IP限制

TRUE

2.5 输入参数说明

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

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

(2)私有参数

参数名称 是否必须 类型 描述
invkey 必须 string 需要验证的好友邀请加密串。跳转到应用首页后,URL后会带该参数。

itime 必须 string 邀请时间。跳转到应用首页后,URL后会带该参数。

iopenid 必须 string 发起邀请者的openid。跳转到应用首页后,URL后会带该参数。

2.6 请求示例

http://113.108.20.23/v3/spread/verify_invkey?openid=B624064BA065E01CB73F835017FE96FA&openkey=5F154D7D2751AEDC8527269006F290F70297B7E54667536C&appid=2&
sig=***********&pf=qzone&format=json&userip=112.90.139.30&iopenid=0000000000000000000000000039811C&
itime=1334202931&invkey=8A96E97D5F393241F04CFD0255550241

2.7 返回参数说明

参数名称 描述
ret 返回码。详见公共返回码说明#OpenAPI V3.0 返回码
msg 如果错误,返回错误信息。
is_lost 判断是否有数据丢失。如果应用不使用cache,不需要关心此参数。

0或者不返回:没有数据丢失,可以缓存。
1:有部分数据丢失或错误,不要缓存。

is_right 1:是被邀请;0:不是被邀请的。

2.8 正确返回示例

JSON示例:

Content-type: text/html; charset=utf-8
{
"ret":0,
"is_lost":0,
"is_right":"0",
}

2.9 错误返回示例

Content-type: text/html; charset=utf-8
{
"ret":1002,
"msg":"请先登录"
}

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

Copyright © 1998 - 2018 Tencent. All Rights Reserved.

腾讯公司 版权所有

有问必答 返回顶部