淘宝API使用须知
淘宝联盟设置使用蚂蚁星球淘宝API需要先申请apikey并进行淘宝授权,您可以在本页面上方点击申请按钮或直接进入个人中心开放API页面申请,单个蚂蚁星球账号只能申请一个apikey。蚂蚁星球开放API是免费使用的,但蚂蚁星球保留对各接口进行调整的权利,我们会在调整时及时给予通知,也请您持续关注我们的公告。
接口地址: http://api-gw.haojingke.com/index.php/v1/api/tb/getunionurl
支持格式: json
请求方式: get/post
请求示例: http://api-gw.haojingke.com/index.php/v1/api/tb/getunionurl?apikey=您的apikey&item_id=
请求参数说明:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
apikey | String | 是 | 蚂蚁星球apikey,请将示例中的key替换成您的key |
item_id | Integer | 是 | 宝贝ID(*必要) |
pid | String | 是 | mm_0000_0000_000, 推广位ID(可在开发者中心设置默认pid)(*必要 需是授权淘宝号下的推广位,如果请求的时候携带了渠道id请求,则该pid需是渠道管理下面的渠道专属推广位) |
relation_id | String | 否 | 渠道ID |
special_id | String | 否 | 会员运营ID |
external_id | String | 否 | 淘宝客外部用户标记,如自身系统账户ID;微信ID等 |
xid(新) | String | 否 | 团长与下游渠道合作的特殊标识,用于统计渠道推广效果(*itemid、xid二选一 或 二选二) |
get_tkl | String | 否 | 是否返回淘口令(0.否;1.是)(默认0)(选填) |
title | String | 否 | 淘口令标题(用于返回淘口令*get_tkl等于1时为必填参数*,需超过8个字符) |
logo | String | 否 | 淘口令弹窗的图片 |
positionid | Int | 否 | 自定义推广位id,整型数字 (蚂蚁星球开发者中心推广位管理中的uid) |
JSON返回示例:
{ "data": { "category_id": "1625",分类ID "coupon_click_url": "https://uland.taobao.com/coupon/edetail?e=BT5m4kNPa%2B6lhHvvyUNXZfh8CuWt5YH5OVuOuRD5gLJMmdsrkidbOcgNAa9X6T79uG1ZaNECU%2FS28bztD9ZlyYv7WfPDvKbYXRuv7xpz1L7QEUCpE4O7Xc3und6mwXdKUqRUtTtZSji%2Bqi5RslGGce9tF5RNjUJqG%2Bsvhyg3hhpwdcbFHm9iHJFnYDcWDF2oMbGusFEnDH5i3DOS540Dp0CLoSLDztJNN9LVSIjIO7oqwPU18YFMoLjtdx6zVCzZH4P3zKhUcU02GOdIiNXzalVusqqnhify&traceId=0bb61b0c16182117715661915ef5f6&&union_lens=lensId:TAPI@1618211771@0b505cf6_087b_178c4f014cd_8025@01;linkRuleId:1",已转链后的您的二合一链接(有券产品)或s.click链接(无券产品),可直接使用 "coupon_end_time": "2021-04-14",优惠券过期时间 (有优惠券时才有此字段) "coupon_info": "满19元减5元",优惠券信息,格式都是“满xx元减xx元”(有优惠券时才有此字段) "coupon_remain_count": "98000",剩余优惠券数量,当为0时优惠券失效。(有优惠券时才有此字段) "coupon_start_time": "2021-04-12",优惠券开始时间(有优惠券时才有此字段) "coupon_total_count": "100000",优惠券发放总量 (有优惠券时才有此字段) "item_id": "580442138828",商品ID "item_url": "https://detail.tmall.com/item.htm?id=580442138828",产品链接 "max_commission_rate": "20.06",常规佣金率:当不入参special_id、relation_id、external_id时,展示常规佣金率(%) "reward_info": "0",比价场景专用,当系统检测到入参消费者ID购买当前商品会获得《天天开彩蛋》玩法的彩蛋时,该字段显示1,否则为0 "cat_leaf_name": "短袜/打底袜/丝袜/美腿袜",分类子叶 "cat_name": "女士内衣/男士内衣/家居服",分类名 "nick": "bonas宝娜斯专卖店", 店铺名称 "num_iid": "580442138828",商品ID "pict_url": "https://img.alicdn.com/bao/uploaded/i3/3162439037/O1CN01UaM8VD2Gczv0diNOn_!!0-item_pic.jpg",商品主图 "presale_deposit": "0",预售商品-定金(元) "presale_end_time": "0",预售商品-付定金结束时间(毫秒) "presale_start_time": "0",预售商品-付定金开始时间(毫秒) "presale_tail_end_time": "0",预售商品-付定金结束时间(毫秒) "presale_tail_start_time": "0",预售商品-付尾款开始时间(毫秒) "provcity": "浙江 金华",商品所在地 "reserve_price": "99",商品一口价格 "seller_id": "3162439037",卖家id "small_images": { [ "https://img.alicdn.com/i2/3162439037/O1CN01OOSKtN2GczlKWg0Tn_!!3162439037.jpg", "https://img.alicdn.com/i3/3162439037/O1CN01FdhGfq2Gczq0pbUGJ_!!3162439037-0-lubanu-s.jpg", "https://img.alicdn.com/i3/3162439037/O1CN0166iB502GcznSLVfAT_!!3162439037.jpg", "https://img.alicdn.com/i2/3162439037/O1CN01zsCNAd2Gczpt1fbDd_!!3162439037-0-lubanu-s.jpg" ] },商品小图列表 "superior_brand": "0",是否品牌精选,0不是,1是 "title": "肉色丝袜女薄款2020新款网红黑丝连裤袜春秋款夏季光腿神器菠萝袜",短链接 "tmall_play_activity_end_time": "0",天猫限时抢可售 -结束时间(毫秒) "tmall_play_activity_start_time": "0",天猫限时抢可售 -开始时间(毫秒) "user_type": "1",卖家类型,1、表示天猫,0、表示淘宝,3表示特价版 "volume": "190409",最近30天销量 "zk_final_price": "19.9",产品折后价 "coupon_short_url": "https://s.click.taobao.com/awxzQpu",短链接 "ios_tbk_pwd": "8¥ue2gXc4PL6M¥ https://m.tb.cn/h.4pGp2tW 肉色丝袜女薄款2020新款网红黑丝连裤袜春秋款夏季光腿神器菠萝袜",针对联盟2020-8-31新出的适用于IOS14的淘口令文案 "tbk_pwd": "¥ue2gXc4PL6M¥",淘口令,此口令是已转化成你自己PID的口令 "tkl": "9(ue2gXc4PL6M) /" 苹果IOS和安卓通用的简化淘口令。可替代 tbk_pwd 和 ios_tbk_pwd }, "message": "success",提示信息 "status_code": 200状态码 200表示请求成功 }
接口地址: http://api-gw.haojingke.com/index.php/v1/api/tb/activity
支持格式: json
请求方式: get/post
请求示例: http://api-gw.haojingke.com/index.php/v1/api/tb/activity?apikey=您的apikey&activity_id=
请求参数说明:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
apikey | String | 是 | 蚂蚁星球apikey,请将示例中的key替换成您的key |
activity_id | String | 是 | 官方活动物料id |
pid | String | 是 | mm_0000_0000_000, 推广位ID(可在开发者中心设置默认pid)(*必要 需是授权淘宝号下的推广位,如果请求的时候携带了渠道id请求,则该pid需是渠道管理下面的渠道专属推广位) |
relation_id | String | 否 | 渠道ID |
union_id | String | 否 | 自定义输入串,英文和数字组成,长度不能大于12个字符,区分不同的推广渠道 |
get_tkl | String | 否 | 是否返回淘口令(0.否;1.是)(默认0)(选填) |
title | String | 否 | 淘口令标题(用于返回淘口令*get_tkl等于1时为必填参数*,需超过8个字符) |
logo | String | 否 | 淘口令弹窗的图片 |
JSON返回示例:
{ "data": { "click_url": "https://s.click.taobao.com/t?union_lens=lensId%3AMAPI%401618206678%402104ccc4_07d2_178c4a25e2a_7e33%4001%3BeventPageId%3A20150318020000462&e=m%3D2%26s%3DGPj1xpRhKgVw4vFB6t2Z2iperVdZeJviPI5Rhak06vZnX1vWUft3ZXCooVp%2Bhaq3%2BCItzojEYRP3HC9F1AE3cLIaDCBC%2F4E2GNMUGoCunc8TV3YQzXSFYdftwTU8qYAgsynDUllKeZHd0%2Bv22oF73US1A3RpE0wVDPxWoA2%2FDBPrMYvMaxVVKsK1DMtXGlsK08EP%2FnJs4K5AFEHVckI7b9XSpRlaJaElaJe2Xd4pkBlyeNAoQluSajK%2FmpnItMR0VaJBM3Fz6%2BgPTtU%2FdIEvWZRwfjTt4rjnSkKImelLej2UB7RP8CFvRlMb9ncl7geF8PwOkD4ulZdpYjsi4suCq9icWZOJx2fePm5r2egYQ0iiZ%2BQMlGz6FQ%3D%3D",链接 "material_oss_url": "http://creative-material-public.oss-cn-shanghai.aliyuncs.com/a/p/20150318020000462.zip",物料素材下载地址 "page_end_time": "2021-08-19",活动结束时间 "page_name": "聚划算百亿补贴页面",会场名称 "page_start_time": "2020-09-16",活动开始时间 "terminal_type": "2",投放平台:1-PC,2-无线 "coupon_short_url": "https://s.click.taobao.com/BScELpu",短链 "ios_tbk_pwd": "3.0¥QdhgXcV9dnZ¥ https://m.tb.cn/h.4ptF0dY 點击“打开”查看并浏览页面详情,精选商品任您选购",针对联盟2020-8-31新出的适用于IOS14的淘口令文案 "tbk_pwd": "¥QdhgXcV9dnZ¥",淘口令,此口令是已转化成你自己PID的口令 "tkl": "8(QdhgXcV9dnZ) /"苹果IOS和安卓通用的简化淘口令。可替代 tbk_pwd 和 ios_tbk_pwd }, "message": "success",提示信息 "status_code": 200状态码 200表示请求成功 }
接口地址: http://api-gw.haojingke.com/index.php/v1/api/tb/shop
支持格式: json
请求方式: get/post
请求示例: http://api-gw.haojingke.com/index.php/v1/api/tb/shop?apikey=您的apikey&user_id=
请求参数说明:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
apikey | String | 是 | 蚂蚁星球apikey,请将示例中的key替换成您的key |
user_id | String | 是 | 卖家ID串,用','分割 |
pid | String | 是 | mm_0000_0000_000, 推广位ID(可在开发者中心设置默认pid)(*必要 需是授权淘宝号下的推广位,如果请求的时候携带了渠道id请求,则该pid需是渠道管理下面的渠道专属推广位) |
relation_id | String | 否 | 渠道ID |
union_id | String | 否 | 自定义输入串,英文和数字组成,长度不能大于12个字符,区分不同的推广渠道 |
get_tkl | String | 否 | 是否返回淘口令(0.否;1.是)(默认0)(选填) |
title | String | 否 | 淘口令标题(用于返回淘口令*get_tkl等于1时为必填参数*,需超过8个字符) |
logo | String | 否 | 淘口令弹窗的图片 |
JSON返回示例:
{ "data": { "click_url": "https://s.click.taobao.com/t?e=m%3D2%26s%3DSRD5KSEVZ0Bw4vFB6t2Z2jAVflQIoZepyK8Cckff7TVRAdhuF14FMfGUfXy3ofD5t4hWD5k2kjO3bcmU2DXU%2FuW76gk5BrvMBXTcnbeNW6f8VNjy6FCpN0m4argXYs%2F4Ke3%2FbelnU7eOJ4hmg2sGJDMrRWVrG%2F%2BL3rfiG8%2Bae61A8ZU6Y7TB%2FigSDy28JSWhQIAW7b5xhq7GDmntuH4VtA%3D%3D&union_lens=lensId:TAPI@1618213923@2105de0e_37d2_178c510ec00_8dc1@01", "user_id": "3162439037",卖家id "ios_tbk_pwd": "6¥DfwXXc4xFqw¥ https://m.tb.cn/h.4LVFUqR bonas宝娜斯专卖店",针对联盟2020-8-31新出的适用于IOS14的淘口令文案 "tbk_pwd": "¥DfwXXc4xFqw¥",淘口令,此口令是已转化成你自己PID的口令 "tkl": "0(DfwXXc4xFqw) /",苹果IOS和安卓通用的简化淘口令。可替代 tbk_pwd 和 ios_tbk_pwd "coupon_short_url": "https://s.click.taobao.com/iK6vQpu"短链 }, "message": "success",提示信息 "status_code": 200状态码 200表示请求成功 }