API文档中心

热门接口:产品ID找同款全量维权查询万能转链字符串ID转换 (有API需求可联系本站)

渠道邀请码生成接口

调用权限:核心接口会员卡调用
接口使用场景等说明:

本接口是用于生成渠道邀请码。

因为邀请码是固定的,所以推荐您直接到联盟后台复制邀请码(建议选“通用备案”,如果你不懂在哪复制邀请码,请参考接口指引中的图解说明)。通常不需要使用接口生成邀请码。

每个开通过渠道权限的联盟账号,每种备案方式(有“通用备案”和“线下门店”等备案方式)都只有一个固定的邀请码,因此,当您已生成过邀请码后,可保存起来下次使用,不必重复生成。比如保存到后台设置项中。以后可以直接取出保存的邀请码再复用。

接口请求地址

环境 http 地址 https 地址
正式环境 http://api.veapi.cn/tbk/invitecode 暂无

请求方式:GETPOST

请求参数

参数名称 参数类型 必填 示例值 描述
vekey String V123M56 公共参数,接口秘钥,请在会员中心获取
code_type Number 1(默认) 邀请码类型:默认1 - 渠道邀请,2 - 渠道裂变,3 -会员邀请。一般本参数不设置,如果要设置为2(裂变),这时可以和relation_id参数配合使用,指定上级的relation_id。但目前联盟对裂变还没处理,无法查询上下级关系,因为裂变还没有意义。
relation_app String common 渠道推广的物料类型,外部媒体调用可统一填写common 类型。可选备案的场景:common(通用备案),etao(一淘备案),minietao(一淘小程序备案),offlineShop(线下门店备案),offlinePerson(线下个人备案)。如不填默认common。查询会员信息只需填写common即可
relationId String   渠道关系ID。示例值:1231512
sessionkey String 7002 多用户专用。如果您的会员卡是多用户版订单查询接口,若要查不同的帐号,请提供该帐号授权的sessionkey值
account_id String 联盟号id 会员中心有多个授权时,用本参数指定要查询哪一个联盟号id,联盟号ID请到会员中心授权页查看

请求示例

  • HTTP
  • PHP
  • JAVA
  • PYTHON
GET/POST  http://api.veapi.cn/tbk/invitecode?vekey=xxx&code_type=x&其它参数=.. 

使用curl函数,curl不是php原生库,需要安装才能使用

$api="http://api.veapi.cn/tbk/invitecode?vekey=xxx&code_type=x&其它参数=..";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api);
//curl_setopt($ch, CURLOPT_POST, true);  //POST方式时启用
//curl_setopt($ch, CURLOPT_POSTFIELDS, $postData );  //POST方式时传参

curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);  //如果使用https请启用
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);  //如果使用https请启用
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true );   //返回数据流,不直接输出
curl_setopt($ch, CURLOPT_ENCODING, 'gzip'); //使用gzip压缩传输让访问更快
curl_setopt($ch, CURLOPT_TIMEOUT, 6);  //允许执行的最长秒数。这里设定6S
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);

$result = curl_exec($ch);
$info = curl_getinfo($ch);
curl_close($ch);

echo $result; //返回值
使用okhttp3/httpclient/jsoup/hutool,以hutool为例:

import cn.hutool.http.HttpResponse;
import cn.hutool.http.HttpRequest;

public class testGetParam {

    public static void main(String[] args) {
        // API网址
        String url = "http://api.veapi.cn/tbk/invitecode?vekey=xxx&code_type=x&其它参数=..";
        // JDK 8u111版本后,若目标页面为HTTPS协议,请启用proxy用户密码鉴权
        //System.setProperty("jdk.http.auth.tunneling.disabledSchemes", "");

        // 发送请求
        String result = HttpRequest.get(url)
                .timeout(10000)//设置超时,毫秒
                .execute().body();
        System.out.println(result);
    }
}
推荐使用 requests,支持访问http,https网页:

import requests
		
# 要访问的API网页
target_url = "http://api.veapi.cn/tbk/invitecode?vekey=xxx&code_type=x&其它参数=.."

# 发送请求
response = requests.get(target_url)

# 获取页面内容
if response.status_code == 200:
	print response.text

返回值(JSON)

参数名称 参数类型 示例值 描述
inviter_code String C9CTAS 接口创建的邀请码,可用于rid备案

返回示例

【提示】推广链接通常有时效性,示例中的链接为创建文档时生成,仅用于展示返回结果使用,有可能已失效。
{ "error": "0", "msg": "淘宝客邀请码生成成功!", "inviter_code": "C9CTAS" }

错误码

如果error不为0时,请点此查看错误码表格

在线
客服

会员请加QQ群交流:

微信
咨询

加微信咨询
顶部