API - 卖家自建开放平台

taobao.vas.subscribe.get

订购关系查询

基础需要授权用户授权介绍收费查看API收费规则

请求地址

环境	HTTP地址	HTTPS地址	请求方式
正式环境	http://open.ieasynote.com/api	https://open.ieasynote.com/api	POST

公共参数

参数名	类型	必须	描述
method	String	是	API接口名称，例如:taobao.vas.subscribe.get
app_key	String	是	TOP分配给应用的AppKey，例如：12345678
session	String	是	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请[点击这里]()。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟
v	String	是	API协议版本，可选值：2.0
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5，hmac-sha256
sign	String	是	API输入参数签名结果，签名算法介绍请[点击这里](
format	String	否	响应格式。默认为xml格式，可选值：xml，json
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false

公共响应参数

公共响应参数中，error_response 和 xxx_response只会出现一个

参数名	类型	描述
request_id	String	平台颁发的每次请求访问的唯一标识
error_response	String	请求访问失败时返回的根节点，和 xxxxx_response 只会出现一个
code	String	请求失败返回的错误码，error_response 的子节点
msg	String	请求失败返回的错误信息，error_response 的子节点
sub_code	String	请求失败返回的子错误码，error_response 的子节点
sub_msg	String	请求失败返回的子错误信息，error_response 的子节点
xxxxx_response	String	请求成功返回的根节点，和 error_response 只会出现一个，'xxxxx' 为API名称的下划线模式，本接口为：vas_subscribe_get_response

请求参数

参数名	类型	必须	示例值	描述
article_code	String	是	ts-1234	商品编码，从合作伙伴后台（my.open.taobao.com）-收费管理-收费项目列表能够获得该应用的商品代码
nick	String	是	hz0799	淘宝会员名

请求响应参数

请求响应参数是 xxx_response 的子节点

参数名	类型	示例值	描述
article_user_subscribes	ArticleUserSubscribe []		用户订购信息
-item_code	String	ts-123-1	收费项目代码
-deadline	Date	2000-01-01 00:00:00	订购关系到期时间

请求示例代码

将接口地址URL设置成: http://open.ieasynote.com/api

                        
                        
$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new VasSubscribeGetRequest;
$req->setArticleCode("ts-1234");
$req->setNick("hz0799");
$resp = $c->execute($req);

                        
                        
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
VasSubscribeGetRequest req = new VasSubscribeGetRequest();
req.setArticleCode("ts-1234");
req.setNick("hz0799");
VasSubscribeGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

                        
                        
ITopClient client = new DefaultTopClient(url, appkey, secret);
VasSubscribeGetRequest req = new VasSubscribeGetRequest();
req.ArticleCode = "ts-1234";
req.Nick = "hz0799";
VasSubscribeGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

                        
                        
# -*- coding: utf-8 -*-
import top.api

req=top.api.VasSubscribeGetRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.article_code="ts-1234"
req.nick="hz0799"
try:
    resp= req.getResponse()
    print(resp)
except Exception,e:
    print(e)

                        
                        
curl -X POST 'http://open.ieasynote.com/api' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=taobao.vas.subscribe.get' \
-d 'partner_id=apidoc' \
-d 'sign=81D1A45CFC54E79F0CE0D8B0BDBB6BAF' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-08-24+11%3A44%3A59' \
-d 'v=2.0' \
-d 'article_code=ts-1234' \
-d 'nick=hz0799'

                        
                        
TopClient = require('./topClient').TopClient;
var client = new TopClient({
    'appkey': 'appkey',
    'appsecret': 'secret',
    'REST_URL': 'http://open.ieasynote.com/api'
});

client.execute('taobao.vas.subscribe.get', {
    'article_code':'ts-1234',
    'nick':'hz0799'
}, function(error, response) {
    if (!error) console.log(response);
    else console.log(error);
})

                        
                        
package main;

import (
    "fmt"
    "topsdk"
    "topsdk/defaultability"
    "topsdk/defaultability/request"
)

func main() {
    client := topsdk.NewDefaultTopClient("<your-appkey>","<your-appsecret>","<top-gateway-url>",20000,20000)
    ability := defaultability.NewDefaultability(&client)


    req := request.TaobaoVasSubscribeGetRequest{}
    req.SetNick("hz0799")
    req.SetArticleCode("ts-1234")


    resp, err := ability.TaobaoVasSubscribeGet(&req)
    if(err != nil) {
        fmt.Println(err)
    } else {
        fmt.Println(resp.Body)
    }
}

                        
                        
<?php
require "../vendor/autoload.php";
use Topsdk\Topapi\TopApiClient;
use Topsdk\Topapi\Defaultability\Request\TaobaoVasSubscribeGetRequest;
use Topsdk\Topapi\Defaultability\Defaultability;


// create Client
$client = new TopApiClient("<your-appkey>","<your-appsecret>","<top-gateway-url>");
$ability = new Defaultability($client);

// create domain

// create request
$request = new TaobaoVasSubscribeGetRequest();
$request->setNick("hz0799");
$request->setArticleCode("ts-1234");

$response = $ability->taobaoVasSubscribeGet($request);
var_dump($response);

                        
                        
import com.alibaba.fastjson.JSON;
import java.io.File;
import java.util.ArrayList;
import java.util.Date;
import com.taobao.top.TopApiClient;
import com.taobao.top.DefaultTopApiClient;
import com.taobao.top.TopFileItem;
import com.taobao.top.defaultability.Defaultability;
import com.taobao.top.defaultability.request.TaobaoVasSubscribeGetRequest;
import com.taobao.top.defaultability.response.TaobaoVasSubscribeGetResponse;

public class Main {

    public static void main(String[] args) throws Exception {
        // create Client
        TopApiClient client = new DefaultTopApiClient("<your-appkey>","<your-appsecret>","<top-gateway-url>");
        Defaultability apiPackage = new Defaultability(client);
        // create domain

        // create request
        TaobaoVasSubscribeGetRequest request = new TaobaoVasSubscribeGetRequest();
        request.setNick("hz0799");
        request.setArticleCode("ts-1234");

        TaobaoVasSubscribeGetResponse response = apiPackage.taobaoVasSubscribeGet(request);
        if(!response.isSuccess()){
            System.out.println(response.getSubMsg());
        }
        System.out.println(JSON.toJSONString(response));
    }
}

响应示例

                        
                        
<vas_subscribe_get_response>
    <article_user_subscribes>
        <article_user_subscribe>
            <item_code>ts-123-1</item_code>
            <deadline>2000-01-01 00:00:00</deadline>
        </article_user_subscribe>
    </article_user_subscribes>
</vas_subscribe_get_response>

                        
                        
{
    "vas_subscribe_get_response":{
        "article_user_subscribes":{
            "article_user_subscribe":[
                {
                    "item_code":"ts-123-1",
                    "deadline":"2000-01-01 00:00:00"
                }
            ]
        }
    }
}

异常响应示例

                        
                            
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>参数异常</sub_msg>
</error_response>

                        
                            
{
    "error_response":{
        "msg":"Remote service error",
        "code":50,
        "sub_msg":"XXX",
        "sub_code":"isv.invalid-parameter"
    }
}

错误码描述

错误码	错误消息	解决方案
暂无错误解释