淘宝开放平台

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

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

名称	类型	是否必须	示例值	描述
rpc_context	RpcContext	可选		基础参数
└ tenant_id String 可选 1000 租户ID └ time_zone String 可选 Asia/Shanghai 时区 └ app_access_key String 可选 app_access_key 应用访问KEY └ app_code String 可选 app_code 应用code └ locale String 可选 en 语言 operator UserInfo 可选人员信息人员信息 └ work_no String 可选 00001 工号 └ auth_provider String 可选 mozi 登陆态 └ corp_id String 可选 corp_id 企业id
card_id	String	可选	cardId	卡片ID

名称	类型	示例值	描述
result	RpcResult	result	返回结果
└ success Boolean true 是否成功 └ error_code Number 1000 错误编码 └ error_msg String error_msg 错误信息 └ content String content content

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAirbiCardGetSchemaRequest req = new AlibabaAirbiCardGetSchemaRequest();
AlibabaAirbiCardGetSchemaRequest.RpcContext obj1 = new AlibabaAirbiCardGetSchemaRequest.RpcContext();
obj1.setTenantId("1000");
obj1.setTimeZone("Asia/Shanghai");
obj1.setAppAccessKey("app_access_key");
obj1.setAppCode("app_code");
obj1.setLocale("en");
AlibabaAirbiCardGetSchemaRequest.UserInfo obj2 = new AlibabaAirbiCardGetSchemaRequest.UserInfo();
obj2.setWorkNo("00001");
obj2.setAuthProvider("mozi");
obj2.setCorpId("corp_id");
obj1.setOperator(obj2);
req.setRpcContext(obj1);
req.setCardId("cardId");
AlibabaAirbiCardGetSchemaResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAirbiCardGetSchemaRequest req = new AlibabaAirbiCardGetSchemaRequest();
AlibabaAirbiCardGetSchemaRequest.RpcContextDomain obj1 = new AlibabaAirbiCardGetSchemaRequest.RpcContextDomain();
obj1.TenantId = "1000";
obj1.TimeZone = "Asia/Shanghai";
obj1.AppAccessKey = "app_access_key";
obj1.AppCode = "app_code";
obj1.Locale = "en";
AlibabaAirbiCardGetSchemaRequest.UserInfoDomain obj2 = new AlibabaAirbiCardGetSchemaRequest.UserInfoDomain();
obj2.WorkNo = "00001";
obj2.AuthProvider = "mozi";
obj2.CorpId = "corp_id";
obj1.Operator= obj2;
req.RpcContext_ = obj1;
req.CardId = "cardId";
AlibabaAirbiCardGetSchemaResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAirbiCardGetSchemaRequest;
$rpc_context = new RpcContext;
$rpc_context->tenant_id="1000";
$rpc_context->time_zone="Asia/Shanghai";
$rpc_context->app_access_key="app_access_key";
$rpc_context->app_code="app_code";
$rpc_context->locale="en";
$operator = new UserInfo;
$operator->work_no="00001";
$operator->auth_provider="mozi";
$operator->corp_id="corp_id";
$rpc_context->operator = $operator;
$req->setRpcContext(json_encode($rpc_context));
$req->setCardId("cardId");
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.airbi.card.get.schema' \
-d 'partner_id=apidoc' \
-d 'sign=F16E36AFFD26BF2C1FA17D58435D76E2' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-14+07%3A33%3A05' \
-d 'v=2.0' \
-d 'card_id=cardId' \
-d 'rpc_context=rpcContext'

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

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

req.rpc_context="rpcContext"
req.card_id="cardId"
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"alibaba.airbi.card.get.schema");
add_param(pRequest,"rpc_context","数据结构JSON示例");
add_param(pRequest,"card_id","cardId");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

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

client.execute('alibaba.airbi.card.get.schema', {
	'rpc_context':'数据结构JSON示例',
	'card_id':'cardId'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_airbi_card_get_schema_response>
    <result>
        <success>true</success>
        <error_code>1000</error_code>
        <error_msg>error_msg</error_msg>
        <content>content</content>
    </result>
</alibaba_airbi_card_get_schema_response>

{
    "alibaba_airbi_card_get_schema_response":{
        "result":{
            "success":true,
            "error_code":1000,
            "error_msg":"error_msg",
            "content":"content"
        }
    }
}

XML示例
JSON示例

<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":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

AirBI

alibaba.airbi.card.get.schema (alibaba.airbi.card.get.schema)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ