本篇文章给大家谈谈api接口文档模板下载,以及api接口文档是干什么的对应的知识点,希望对各位有所帮助,不要忘了收藏本站喔。
今天给各位分享api接口文档模板下载的知识,其中也会对api接口文档是干什么的进行解释,如果能碰巧解决你现在面临的问题,别忘了关注本站,现在开始吧!
本文目录一览:
免费API接口的试用开发文档有吗
Api接口就好比一个媒介工具,比如买东西的时候我们要计算价格,可以用算盘、计算器、手机或者电脑进行计算得出结果。接口与其类似,当你需要用到这个功能时就可以调用。
Api接口可以应用于pc端、app、软件等,除了接口一般会有Api接口文档说明来帮助开发者使用。
下面来分享一下免费的api接口以及文档说明:
1. 邮编查询:
接口地址:http://v.juhe.cn/postcode/query
返回格式:json/xml
请求方式:http get/post
请求示例:http://v.juhe.cn/postcode/query?postcode=215001key=申请的KEY
接口备注:通过邮编查询对应的地名
请求参数说明:
名称 类型 必填 说明
postcode 是 string 邮编,如:215001
key 是 string 应用APPKEY(应用详细页查询)
page 否 int 页数,默认1
pagesize 否 int 每页返回,默认:20,最大不超过50
dtype 否 string 返回数据的格式,xml或json,默认json
返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回说明
JSON返回示例:
{
"reason": "successed",
"result": {
"list": [
{
"PostNumber": "215001",
"Province": "江苏省",
"City": "苏州市",
"District": "平江区",
"Address": "廖家巷新光里"
},
{
"PostNumber": "215001",
"Province": "江苏省",
"City": "苏州市",
"District": "平江区",
"Address": "龙兴桥顺德里"
}
],
"totalcount": 352,
"totalpage": 176,
"currentpage": 1,
"pagesize": "2"
},
"error_code": 0
}
2. 手机号码归属地:
接口地址:http://apis.juhe.cn/mobile/get
返回格式:json/xml
请求方式:get
请求示例:http://apis.juhe.cn/mobile/get?phone=13429667914key=您申请的KEY
请求参数说明:
名称 类型 必填 说明
phone 是 int 需要查询的手机号码或手机号码前7位
key 是 string 应用APPKEY(应用详细页查询)
dtype 否 string 返回数据的格式,xml或json,默认json
返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回说明
result string 返回结果集
province string 省份
city string 城市,(北京、上海、重庆、天津直辖市可能为空)
areacode string 区号,(部分记录可能为空)
zip string 邮编,(部分记录可能为空)
company string 运营商
JSON返回示例:
{
"resultcode":"200",
"reason":"Return Successd!",
"result":{
"province":"浙江",
"city":"杭州",
"areacode":"0571",
"zip":"310000",
"company":"中国移动",
"card":""
}
}
XML返回示例:
<?xml version="1.0" encoding="utf-8" ?
- <root
<resultcode200</resultcode
<reasonReturn Successd!</reason
- <result
<province浙江</province
<city杭州</city
<areacode0571</areacode
<zip310000</zip
<company中国移动</company
<card</card
</result
</root
3. 影视影讯检索:
接口地址:http://op.juhe.cn/onebox/movie/video
返回格式:json/xml
请求方式:http get/post
请求事例http://op.juhe.cn/onebox/movie/video?key=APPKEYq=%E5%BA%B7%E7%86%99%E7%8E%8B%E6%9C%9D
接口备注:电影:q=心花路放;电视剧:q=继承者们;动漫:q=柯南
请求参数说明:
名称 类型 必填 说明
key 是 string 应用APPKEY(应用详细页查询)
dtype 否 string 返回数据的格式,xml或json,默认json
q 是 string 影视搜索名称
返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回说明
JSON返回示例:
{
"reason": "查询成功",
"result": {
"title": "闪电侠第一季",
"tag": "科幻 / 动作",
"act": "格兰特·古斯汀 埃涅·赫德森 汤姆·卡瓦纳夫",
"year": "2014",
"rating": null,
"area": "美国",
"dir": "大卫·努特尔",
"desc": "《闪电侠》精彩看点:二次元超级英雄再登电视荧屏,《闪电侠》无缝对接《绿箭侠》闪耀登场。《闪电侠》剧情梗概:《闪电侠》的漫画连载开始于1940年,讲述了一名拥有超级速度的学生的故事。50年代起,这个角色则被重新诠释,成为了巴里·艾伦,一名为警署工作的科学家,使用他的超级速度来对抗超级反派们。",
"cover": "http://i.gtimg.cn/qqlive/img/jpgcache/files/qqvideo/0/0l01jm9yobh4xo4.jpg",
"vdo_status": "play",
"playlinks": {
"youku": "http://v.youku.com/v_show/id_XODQ1NTAzNDE2.html?tpa=dW5pb25faWQ9MTAyMjEzXzEwMDAwNl8wMV8wMQ",
"qq": "http://v.qq.com/cover/0/0l01jm9yobh4xo4/g0015dn2fw1.html",
"leshi": "http://www.letv.com/ptv/vplay/21416940.html",
"pptv": "http://v.pptv.com/show/2uhW1T2jE1G0Mr4.html",
"sohu": "http://tv.sohu.com/20141210/n406824703.shtml?txid=4e4df35dda9d8ed32c874b1ad590ef59"
},
"video_rec": [
{
"detail_url": "http://kan.com/tv/PrVtaX7kRzXsMn.html",
"cover": "http://p2.qhimg.com/t01f969930fae67d1ec.jpg",
"title": "神盾局特工 第2季"
},
{
"detail_url": "http://kan.com/tv/Q4RvaqOoRmDuMX.html",
"cover": "http://p6.qhimg.com/t0160a8a6f5b768034a.jpg",
"title": "遗失的世界"
},
{
"detail_url": "http://kan.com/tv/Q4Frc3GoRmbuMX.html",
"cover": "http://p7.qhimg.com/t01513514907831e055.jpg",
"title": "浩劫余生 第一季"
},
{
"detail_url": "http://kan.com/tv/QrFob33oRGboMX.html",
"cover": "http://p6.qhimg.com/d/_hao360/video/img200909_18_145544738.jpg",
"title": "新绿野仙踪之铁皮人"
},
{
"detail_url": "http://kan.com/tv/QrRtbaOpRz4nOH.html",
"cover": "http://p1.qhimg.com/t01d2996b3305923b91.jpg",
"title": "陨落星辰第三季"
}
],
"act_s": [
{
"name": "格兰特·古斯汀",
"url": "http://baike.so.com/doc/2041872.html",
"image": "http://p3.qhimg.com/dmsmty/120_110_100/t019f2fb2f92c6cb2cf.jpg"
},
{
"name": "埃涅·赫德森",
"url": "http://baike.so.com/doc/3938849.html",
"image": "http://p2.qhimg.com/dmsmty/120_110_100/t0169332727e692e9fa.jpg"
},
{
"name": "汤姆·卡瓦纳夫",
"url": "http://baike.so.com/doc/7521211.html",
"image": "http://p0.qhimg.com/dmsmty/120_110_100/t01d271d8c090330ae2.jpg"
}
]
},
"error_code": 0
}
4. 商品比价查询:
API调用地址:
http://sapi.manmanbuy.com/Search.aspx?AppKey=申请appkeyKey=搜索关键词Class=分类IDBrand=品牌IDSite=商城IDPriceMin=最低价PriceMax=最高价PageNum=页号PageSize=每页商品数OrderBy=排序方式ZiYing=是否自营ExtraParameter=扩展参数
调用示例
http://sapi.manmanbuy.com/Search.aspx?AppKey=123456Key=iphoneClass=0Brand=0Site=0PriceMin=0PriceMax=0PageNum=1PageSize=30OrderBy=scoreZiYing=falseExtraParameter=0
返回结果示例(以iphone为例,显示前2条商品信息):
{"State":1000,"SearchItemsCount":101520,"SearchCount":5109,"ClassList":"57|1074|手机,893|29964|iPhone 配件,892|19512|手机保护套,910|11169|苹果配件, 890|8766|手机贴膜 ,894|6201|其它配件,900|3189|移动电源,889|2067|手机充电器,898|1923|电池/充电器,101|1518|耳机,888|1290|手机电池, 100|1074|蓝牙耳机","BrandList":"155|47184|苹果,0|40476|,634|2166|洛克,6|1134|三星,622|1023|倍思,261|564|品胜,652|558|SGP, 639|537|ESR,623|474|邦克仕,10|423|飞利浦,604|330|摩米士,664|291|优胜仕","SiteList":"1|66732|京东商城,4|8478|亚马逊,3|7917| 当当,13|4821|1号店,6|4605|苏宁易购,8|4149|国美在线,11|3882|易迅网,9|360|新蛋网,161|168|飞牛网,185|147|顺电网,124|123|高鸿商城, 123|69|华强北","SearchResultList":[{"spname":"苹果(Apple)iPhone 6 (A1586) 16GB 金色 移动联通电信4G手机", "sppic":"http://img14.360buyimg.com/n7/jfs/t277/193/1005339798/768456/29136988/542d0798N19d42ce3.jpg", "spurl":"http://item.jd.com/1217499.html","spprice":"5188.00","className":"手机","brandName":"苹果","siteName":"京东商城", "commentUrl":"http://item.jd.com/1217499.html#comments-list","commentCount":"8773", "TitleHighLighter":"苹果(Apple)iPhone 6 (A1586) 16GB 金色 移动联通电信4G手机","ziying":"1","siteid":"1","id":"98084930"}, {"spname":"苹果(Apple)iPhone 6 Plus (A1524) 16GB 金色 移动联通电信4G手机", "sppic":"http://img14.360buyimg.com/n7/jfs/t346/302/1010969394/231745/50f20b36/542d0e26N894372e9.jpg", "spurl":"http://item.jd.com/1217524.html","spprice":"5988.00","className":"手机","brandName":"苹果","siteName":"京东商城", "commentUrl":"http://item.jd.com/1217524.html#comments-list","commentCount":"10288", "TitleHighLighter":"苹果(Apple)iPhone 6 Plus (A1524) 16GB 金色 移动联通电信4G手机","ziying":"1","siteid":"1","id":"98084932"}]}
java api接口文档编写
Java语言提供了一种强大的注释形式:文档注释。可以将源代码里的文档注释提取成一份系统的API文档。我们在开发中定义类、方法时可以先添加文档注释,然后使用javadoc工具来生成自己的API文档。
文档注释以斜线后紧跟两个星号(/**)开始,以星号后紧跟一个斜线(*/)作为结尾,中间部分全部都是文档注释,会被提取到API文档中。
自行搜索一下javadoc即可,示例如下:
/**
* 类描述
*
* @author 作者
* @version 版本
*/
public class DemoClass {
/**
* 内部属性:name
*/
private String name;
/**
* Setter方法
* @return name
*/
public String getName() {
return name;
}
/**
* Getter方法
* @param name
*/
public void setName(String name) {
this.name = name;
}
}
电商管理后台 API 接口文档
type=tree
###同步商品图片
###同步商品属性
###商品图片处理必须安装 GraphicsMagick
如何使 WebAPI 自动生成漂亮又实用在线API文档
1.1 SwaggerUI
SwaggerUI 是一个简单的Restful API 测试和文档工具。简单、漂亮、易用(官方demo)。通过读取JSON 配置显示API. 项目本身仅仅也只依赖一些 html,css.js静态文件. 你可以几乎放在任何Web容器上使用。
1.2 Swashbuckle
Swashbuckle 是.NET类库,可以将WebAPI所有开放的控制器方法生成对应SwaggerUI的JSON配置。再通过SwaggerUI 显示出来。类库中已经包含SwaggerUI 。所以不需要额外安装。
2.快速开始
创建项目 OnlineAPI来封装百度音乐服务(示例下载) ,通过API可以搜索、获取音乐的信息和播放连接。
我尽量删除一些我们demo中不会用到的一些文件,使其看上去比较简洁。
WebAPI 安装 Swashbuckle
Install-Package Swashbuckle
代码注释生成文档说明。
Swashbuckle 是通过生成的XML文件来读取注释的,生成 SwaggerUI,JSON 配置中的说明的。
安装时会在项目目录 App_Start 文件夹下生成一个 SwaggerConfig.cs 配置文件,用于配置 SwaggerUI 相关展示行为的。如图:
将配置文件大概99行注释去掉并修改为
c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));
并在当前类中添加一个方法
/// <summary
/// </summary
/// <param name="name"</param
/// <returns</returns
protected static string GetXmlCommentsPath(string name)
{
return string.Format(@"{0}\bin\{1}.XML", AppDomain.CurrentDomain.BaseDirectory, name);
}
紧接着你在此Web项目属性生成选卡中勾选 “XML 文档文件”,编译过程中生成类库的注释文件
添加百度音乐 3个API
访问 lt;youhost/swagger/ui/index,最终显示效果
我们通过API 测试API 是否成功运行
3.添加自定义HTTP Header
在开发移动端 API时常常需要验证权限,验证参数放在Http请求头中是再好不过了。WebAPI配合过滤器验证权限即可
首先我们需要创建一个 IOperationFilter 接口的类。IOperationFilter
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Http;
using System.Web.Http.Description;
using System.Web.Http.Filters;
using Swashbuckle.Swagger;
namespace OnlineAPI.Utility
{
public class HttpHeaderFilter : IOperationFilter
{
public void Apply(Operation operation, SchemaRegistry
schemaRegistry, ApiDescription apiDescription)
{
if (operation.parameters == null) operation.parameters = new
List<Parameter();
var filterPipeline =
apiDescription.ActionDescriptor.GetFilterPipeline();
//判断是否添加权限过滤器
var isAuthorized = filterPipeline.Select(filterInfo =
filterInfo.Instance).Any(filter = filter is IAuthorizationFilter);
//判断是否允许匿名方法
var allowAnonymous =
apiDescription.ActionDescriptor.GetCustomAttributes<AllowAnonymousAttribute().Any();
if (isAuthorized !allowAnonymous)
{
operation.parameters.Add(new Parameter
{
name = "access-key",
@in = "header",
description = "用户访问Key",
required = false,
type = "string"
});
}
}
}
}
在 SwaggerConfig.cs 的 EnableSwagger 配置匿名方法类添加一行注册代码
c.OperationFilter<HttpHeaderFilter();
添加Web权限过滤器
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Text;
using System.Web;
using System.Web.Http;
using System.Web.Http.Controllers;
using Newtonsoft.Json;
namespace OnlineAPI.Utility
{
/// <summary
///
/// </summary
public class AccessKeyAttribute : AuthorizeAttribute
{
/// <summary
/// 权限验证
/// </summary
/// <param name="actionContext"</param
/// <returns</returns
protected override bool IsAuthorized(HttpActionContext actionContext)
{
var request = actionContext.Request;
if (request.Headers.Contains("access-key"))
{
var accessKey = request.Headers.GetValues("access-key").SingleOrDefault();
//TODO 验证Key
return accessKey == "123456789";
}
return false;
}
/// <summary
/// 处理未授权的请求
/// </summary
/// <param name="actionContext"</param
protected override void HandleUnauthorizedRequest(HttpActionContext actionContext)
{
var content = JsonConvert.SerializeObject(new {State = HttpStatusCode.Unauthorized});
actionContext.Response = new HttpResponseMessage
{
Content = new StringContent(content, Encoding.UTF8, "application/json"),
StatusCode = HttpStatusCode.Unauthorized
};
}
}
}
在你想要的ApiController 或者是 Action 添加过滤器
[AccessKey]
最终显示效果
4.显示上传文件参数
SwaggerUI 有上传文件的功能和添加自定义HTTP Header 做法类似,只是我们通过特殊的设置来标示API具有上传文件的功能
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Http.Description;
using Swashbuckle.Swagger;
namespace OnlineAPI.Utility
{
/// <summary
///
/// </summary
public class UploadFilter : IOperationFilter
{
/// <summary
/// 文件上传
/// </summary
/// <param name="operation"</param
/// <param name="schemaRegistry"</param
/// <param name="apiDescription"</param
public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
{
if (!string.IsNullOrWhiteSpace(operation.summary) operation.summary.Contains("upload"))
{
operation.consumes.Add("application/form-data");
operation.parameters.Add(new Parameter
{
name = "file",
@in = "formData",
required = true,
type = "file"
});
}
}
}
}
在 SwaggerConfig.cs 的 EnableSwagger 配置匿名方法类添加一行注册代码
c.OperationFilter<UploadFilter();
API 文档展示效果
还在发愁写API文档?推荐一款阿里腾讯都在用的API管理神器
作为一个前后端分离模式开发的团队,api接口文档模板下载我们经常会看到这样的场景:前端开发和后端开发在一起热烈的讨论“你这接口参数怎么又变了api接口文档模板下载?”,“接口怎么又不通了?”,“稍等,我调试下”,“你再试试..."。
那能不能写好接口文档,大家都按文档来开发?很难,因为写文档、维护文档比较麻烦,而且费时,还会经常出现 API 更新了,但文档还是旧的,各种同步不一致的情况,从而耽搁彼此的时间。
之前我们团队也遇到了同样的问题,那么作为研发团队的负责人,我是如何带领团队解决这个问题的呢?
方法其实很简单,如果能做到让写文档/维护文档这件事情的短期收益就能远高于付出的成本,那么所有问题都能迎刃而解,开发人员就会非常乐意去写接口文档。
要做到写文档和及时维护文档的短期收益就能远高于付出的成本,无非两个方向:
鉴于此,我们设想如果有一款工具做到以下这些是不是就非常爽了?
总结下来,我们需要的就是这么一款工具:
为此,我们几乎尝遍了市面上所有相关的工具,但是很遗憾,没有找到合适的。
于是,我们自己实现了一个Postman + Swagger + RAP + JMeter
这个工具就是 Apifox,经常很长一段时间不断更新迭代后,我们基本上完全实现了最初的设想,几乎完美解决了最开始遇到的所有问题,在公司内部大受欢迎。并且也形成了我们自己的最佳实践。
没错,现在我们已经将Apifox产品化对外服务了,你们团队也可以直接使用Apifox了。
官网:www.apifox.cn
Apifox = Postman + Swagger + Mock + JMeter
Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台。
通过一套系统、一份数据,解决多个系统之间的数据同步问题。只要定义好接口文档,接口调试、数据 Mock、接口测试就可以直接使用,无需再次定义;接口文档和接口开发调试使用同一个工具,接口调试完成后即可保证和接口文档定义完全一致。高效、及时、准确!
节省研发团队的每一分钟!
如果你认为 Apifox 只做了数据打通,来提升研发团队的效率,那就错了。Apifox 还做了非常多的创新,来提升开发人员的效率。
通常一个接口会有多种情况用例,比如 正确用例 参数错误用例 数据为空用例 不同数据状态用例。定义接口的时候定义好这些不同状态的用例,接口调试的时候直接运行,非常高效。
可以独立定义数据模型,接口定义时可以直接引用数据模型,数据模型之间也可以相互引用。同样的数据结构,只需要定义一次即可多处使用;修改的时候只需要修改一处,多处实时更新,避免不一致。
使用 Apifox 调试接口的时候,系统会根据接口文档里的定义,自动校验返回的数据结构是否正确,无需通过肉眼识别,也无需手动写断言脚本检测,非常高效!
Apifox 自动校验数据结构
设置断言:
Apifox 设置断言
运行后,查看断言结果:
先放一张图对比下 Apifox 和其他同类工具 零配置 mock 出来的数据效果:
Apifox Mock 数据结果对比同类工具
可以看出 Apifox 零配置 Mock 出来的数据和真实情况是非常接近的,前端开发可以直接使用,而无需再手动写 mock 规则。
「Apifox 如何做到高效率、零配置生成非常人性化的 mock 数据」
Apifox 项目可“在线分享” API 文档,分享出去的 API 文档可设置为公开或需要密码访问,非常方便与外部团队协作。
体验地址:https://www.apipark.cn/s/ce387612-cfdb-478a-b604-b96d1dbc511b/http/5041285
根据接口模型定义,自动生成各种语言/框架(如 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等)的业务代码(如 Model、Controller、单元测试代码等)和接口请求代码。目前 Apifox 支持 130 种语言及框架的代码自动生成。
更重要的是:你可以通过自定义代码模板来生成符合自己团队的架构规范的代码,满足各种个性化的需求。
接口调试
Apifox 多种主题色可选
淘宝/天猫官方商品/订单订单API接口
测试网址
api接口文档模板下载:点击免费测试注册 - 跨境电商平台接口提供商 数据采集公司 数据接口定制服务 企业级数据服务商
商品接口列表产品管理包
Taobao.product.get 获取一个产品的信息 官方文档
Taobao.products.search 搜索产品信息 官方文档
Taobao.product.add 上传一个产品
api接口文档模板下载,不包括产品非主图和属性图片 官方文档
Taobao.product.img.upload 上传单张产品非主图
api接口文档模板下载,如果需要传多张
api接口文档模板下载,可调多次 官方文档
Taobao.product.propimg.upload 上传单张产品属性图片
api接口文档模板下载,如果需要传多张,可调多次 官方文档
Taobao.product.update 修改一个产品,可以修改主图,不能修改子图片 官方文档
Taobao.products.get 获取产品列表 官方文档
商品类目属性
Taobao.itempropvalues.get 获取标准类目属性值 官方文档
Taobao.itemprops.get 获取标准商品类目属性 官方文档
Taobao.itemcats.get 获取后台供卖家发布商品的标准商品类目 官方文档
店铺信息查询
Taobao.shopcats.list.get 获取前台展示的店铺类目 官方文档
Taobao.sellercats.list.get 获取前台展示的店铺内卖家自定义商品类目 官方文档
Taobao.shop.seller.get 卖家店铺基础信息查询 官方文档
店铺信息更新
Taobao.sellercats.list.add 添加卖家自定义类目 官方文档
Taobao.sellercats.list.update 更新卖家自定义类目 官方文档
Taobao.shop.update 更新店铺基本信息 官方文档
退款管理包
Taobao.refunds.apply.get 查询买家申请的退款列表 官方文档
Taobao.refunds.receive.get 查询卖家收到的退款列表 官方文档
Taobao.refund.get 获取单笔退款详情 官方文档
Taobao.refund.messages.get 查询退款留言/凭证列表 官方文档
Taobao.refund.message.add 创建退款留言/凭证 官方文档
Taobao.refund.refuse 卖家拒绝退款 官方文档
Schema商品发布
Tmall.item.schema.add 天猫根据规则发布商品 官方文档
Tmall.item.add.schema.get 天猫发布商品规则获取 官方文档
Tmall.product.add.schema.get 产品发布规则获取接口 官方文档
Tmall.product.match.schema.get 获取匹配产品规则 官方文档
Tmall.product.schema.match product匹配接口 官方文档
Tmall.product.schema.add 使用Schema文件发布一个产品 官方文档
Tmall.product.update.schema.get 产品更新规则获取接口 官方文档
Tmall.product.schema.update 产品更新接口 官方文档
Tmall.item.schema.update 天猫根据规则编辑商品 官方文档
Tmall.item.update.schema.get 天猫编辑商品规则获取 官方文档
Tmall.product.schema.get 产品信息获取schema获取 官方文档
Tmall.item.increment.update.schema.get 天猫增量更新商品规则获取 官方文档
Tmall.item.schema.increment.update 天猫根据规则增量更新商品 官方文档
Tmall.item.add.simpleschema.get 天猫发布商品规则获取 官方文档
Tmall.item.calculate.hscode.get 算法获取hscode 官方文档
Tmall.item.hscode.detail.get 通过hscode获取计量单位 官方文档
Tmall.item.hscode.audit.results.query 商品hscode信息审核状态查询接口 官方文档
商品价格更新
Taobao.item.price.update 更新商品价格 官方文档
Tmall.item.price.update 天猫商品/SKU价格更新接口 官方文档
商品上下架
Taobao.item.update.delisting 商品下架 官方文档
Taobao.item.update.listing 一口价商品上架 官方文档
卖家商品查询
Taobao.items.onsale.get 获取当前会话用户出售中的商品列表 官方文档
Taobao.item.sku.get 获取SKU 官方文档
Taobao.item.skus.get 根据商品ID列表获取SKU信息 官方文档
Taobao.itemcats.authorize.get 查询商家被授权品牌列表和类目列表 官方文档
Taobao.items.inventory.get 得到当前会话用户库存中的商品列表 官方文档
Taobao.items.custom.get 根据外部ID取商品 官方文档
Taobao.skus.custom.get 根据外部ID取商品SKU 官方文档
商品同步
Taobao.item.seller.get 获取单个商品详细信息 官方文档
Taobao.items.seller.list.get 批量获取商品详细信息 官方文档
商品编辑
Taobao.item.update 更新商品信息 官方文档
Taobao.item.add 添加一个商品 官方文档
Taobao.item.img.upload 添加商品图片 官方文档
Taobao.item.img.delete 删除商品图片 官方文档
Taobao.item.propimg.delete 删除属性图片 官方文档
Taobao.item.propimg.upload 添加或修改属性图片 官方文档
Taobao.item.sku.add 添加SKU 官方文档
Taobao.item.sku.update 更新SKU信息 官方文档
Taobao.item.delete 删除单条商品 官方文档
Taobao.item.joint.img 商品关联子图 官方文档
Taobao.item.joint.propimg 商品关联属性图 官方文档
Taobao.item.sku.delete 删除SKU 官方文档
Taobao.item.quantity.update 宝贝/SKU库存修改 官方文档
Taobao.item.templates.get 获取用户宝贝详情页模板名称 官方文档
Taobao.item.sku.price.update 更新商品SKU的价格 官方文档
Taobao.skus.quantity.update SKU库存修改 官方文档
Taobao.item.anchor.get 获取可用宝贝描述规范化模块 官方文档
Tmall.item.desc.modules.get 商品描述模块信息获取 官方文档
Taobao.item.barcode.update 更新商品条形码信息 官方文档
Tmall.item.sizemapping.templates.list 获取天猫商品尺码表模板列表 官方文档
Tmall.item.sizemapping.template.get 获取天猫商品尺码表模板 官方文档
Tmall.item.sizemapping.template.delete 删除天猫商品尺码表模板 官方文档
Tmall.item.sizemapping.template.update 更新天猫商品尺码表模板 官方文档
Tmall.item.sizemapping.template.create 新增天猫商品尺码表模板 官方文档
Tmall.item.outerid.update 天猫商品/SKU商家编码更新接口 官方文档
Tmall.item.shiptime.update 更新商品发货时间 官方文档
Tmall.item.simpleschema.add 天猫简化发布商品 官方文档
Tmall.item.simpleschema.update 天猫简化编辑商品 官方文档
Tmall.item.quantity.update 天猫商品/SKU库存更新接口 官方文档
卖家信息查询
Taobao.user.seller.get 查询卖家用户信息 官方文档
图片管理
Taobao.picture.category.get 获取图片分类信息 官方文档
Taobao.picture.get 获取图片信息 官方文档
Taobao.picture.delete 删除图片空间图片 官方文档
Taobao.picture.upload 上传单张图片 官方文档
Taobao.media.category.update 更新媒体文件分类 官方文档
Taobao.picture.category.add 新增图片分类信息 官方文档
Taobao.picture.category.update 更新图片分类 官方文档
Taobao.picture.replace 替换图片 官方文档
Taobao.picture.update 修改图片名字 官方文档
Taobao.picture.userinfo.get 查询图片空间用户的信息 官方文档
Taobao.picture.isreferenced.get 图片是否被引用 官方文档
Taobao.picture.pictures.get 图片获取 官方文档
Taobao.picture.pictures.count 图片总数查询 官方文档
订单接口列表(新)物流管理包
Taobao.delivery.template.get 获取用户指定运费模板信息 官方文档
Taobao.delivery.templates.get 获取用户下所有模板 官方文档
Taobao.delivery.template.delete 删除运费模板 官方文档
Taobao.delivery.template.add 新增运费模板 官方文档
Taobao.delivery.template.update 修改运费模板 官方文档
Taobao.logistics.consign.resend 修改物流公司和运单号 官方文档
AG退款流程接入
Taobao.nextone.logistics.warehouse.update AG退货入仓状态写接口 官方文档
Taobao.rdc.aligenius.refunds.check 退款信息审核 官方文档
Taobao.rdc.aligenius.sendgoods.cancel 取消发货 官方文档
Taobao.rdc.aligenius.account.validate AG商家账号校验 官方文档
Taobao.rdc.aligenius.warehouse.resend.logistics.msg.post 补发单物流信息回传 官方文档
Taobao.rdc.aligenius.warehouse.resend.update 补发单状态回传 官方文档
Taobao.rdc.aligenius.ordermsg.update 订单消息状态回传 官方文档
Taobao.rdc.aligenius.warehouse.reverse.event.update 销退单事件回传接口 官方文档
Taobao.rdc.aligenius.warehouse.reverse.uploading 销退单上传 官方文档
Taobao.rdc.aligenius.identification.case.result.update 鉴定工单结果同步 官方文档
Taobao.rdc.aligenius.identification.case.update 鉴定工单信息同步 官方文档
物流基础信息查询
Taobao.areas.get 查询地址区域 官方文档
Taobao.logistics.companies.get 查询物流公司信息 官方文档
Taobao.logistics.partners.get 查询支持起始地到目的地范围的物流公司 官方文档
卖家地址库管理
Taobao.logistics.address.search 查询卖家地址库 官方文档
Taobao.logistics.address.remove 删除卖家地址库 官方文档
Taobao.logistics.address.modify 卖家地址库修改 官方文档
Taobao.logistics.address.add 卖家地址库新增接口 官方文档
Taobao.logistics.address.reachable 判定服务是否可达 官方文档
Taobao.logistics.address.reachablebatch.get 批量判定服务是否可达 官方文档
商品类目属性
Taobao.itempropvalues.get 获取标准类目属性值 官方文档
Taobao.itemprops.get 获取标准商品类目属性 官方文档
Taobao.itemcats.get 获取后台供卖家发布商品的标准商品类目 官方文档
获取单笔交易信息
Taobao.trade.get 获取单笔交易的部分信息(性能高) 官方文档
退款管理包
Taobao.refunds.apply.get 查询买家申请的退款列表 官方文档
Taobao.refunds.receive.get 查询卖家收到的退款列表 官方文档
Taobao.refund.get 获取单笔退款详情 官方文档
Taobao.refund.messages.get 查询退款留言/凭证列表 官方文档
Taobao.refund.message.add 创建退款留言/凭证 官方文档
Taobao.refund.refuse 卖家拒绝退款 官方文档
物流订单查询
Taobao.logistics.orders.detail.get 批量查询物流订单,返回详细信息 官方文档
Taobao.logistics.orders.get 批量查询物流订单 官方文档
Taobao.logistics.trace.search 物流流转信息查询 官方文档
Taobao.wlb.order.jz.query 家装业务查询物流公司api 官方文档
Taobao.wlb.order.jz.consign 家装发货接口 官方文档
物流发货
Taobao.logistics.online.send 在线订单发货处理(支持货到付款) 官方文档
Taobao.logistics.online.cancel 取消物流订单接口 官方文档
Taobao.logistics.online.confirm 确认发货通知接口 官方文档
Taobao.logistics.offline.send 自己联系物流(线下物流)发货 官方文档
Taobao.logistics.dummy.send 无需物流(虚拟)发货处理 官方文档
Taobao.logistics.order.create 创建物流订单 官方文档
Taobao.logistics.consign.order.createandsend 创建订单并发货 官方文档
Taobao.wlb.stores.baseinfo.get 商家按照仓的类型获取仓库接口 官方文档
Taobao.logistics.consign.tc.confirm 通知交易确认发货接口 官方文档
Cainiao.nbadd.appointdeliver.getconsigninfo 获取支持定时派送服务发货信息 官方文档
订单编辑
Taobao.trade.memo.add 对一笔交易添加备注 官方文档
Taobao.trade.memo.update 修改交易备注 官方文档
Taobao.trade.ordersku.update 更新交易的销售属性 官方文档
Taobao.trade.shippingaddress.update 更改交易的收货地址 官方文档
Taobao.trade.receivetime.delay 延长交易收货时间 官方文档
Taobao.trade.postage.update 修改交易邮费价格 官方文档
订单信息查询
Taobao.trades.sold.get 查询卖家已卖出的交易数据(根据创建时间) 官方文档
Taobao.trade.fullinfo.get 获取单笔交易的详细信息 官方文档
Taobao.trades.sold.increment.get 查询卖家已卖出的增量交易数据(根据修改时间) 官方文档
Taobao.trade.confirmfee.get 获取交易确认收货费用 官方文档
Taobao.trade.amount.get 交易帐务查询 官方文档
Taobao.trades.sold.incrementv.get 查询卖家已卖出的增量交易数据(根据入库时间) 官方文档
退款退货
Taobao.rp.refunds.agree 同意退款 官方文档
Taobao.rp.returngoods.agree 卖家同意退货 官方文档
Taobao.rp.refund.review 审核退款单 官方文档
Taobao.rp.returngoods.refill 卖家回填物流信息 官方文档
Taobao.rp.returngoods.refuse 卖家拒绝退货 官方文档
Taobao.refund.refusereason.get 获取拒绝原因列表 官方文档
Tmall.dispute.receive.get 天猫逆向纠纷查询 官方文档
评价信息更新
Taobao.traderate.add 新增单个评价 官方文档
Taobao.traderate.list.add 针对父子订单新增批量评价 官方文档
Taobao.traderate.explain.add 商城评价解释接口 官方文档
评价信息查询
Taobao.traderates.get 搜索评价信息 官方文档
Taobao.traderate.impr.imprwords.get 评价大家印象印象短语接口 官方文档
Tmall.traderate.feeds.get 查询子订单对应的评价、追评以及语义标签 官方文档
Tmall.traderate.itemtags.get 通过商品ID获取标签列表 官方文档
电子面单
Taobao.wlb.waybill.i.get 获取物流服务商电子面单号v1.0 官方文档
Taobao.wlb.waybill.i.search 查询面单服务订购及面单使用情况v1.0 官方文档
Taobao.wlb.waybill.i.fullupdate 面单信息更新接口v1.0 官方文档
Taobao.wlb.waybill.i.print 打印确认接口v1.0 官方文档
Taobao.wlb.waybill.i.querydetail 查面单号状态v1.0
关于api接口文档模板下载和api接口文档是干什么的的介绍到此就结束了,不知道你从中找到你需要的信息了吗 ?如果你还想了解更多这方面的信息,记得收藏关注本站。
api接口文档模板下载的介绍就聊到这里吧,感谢你花时间阅读本站内容,更多关于api接口文档是干什么的、api接口文档模板下载的信息别忘了在本站进行查找喔。
版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。
暂时没有评论,来抢沙发吧~