api接口文档

合集下载

开发接口文档-API文档模板

code messageXXX项目接口文档1获取所有字段1.1获取所有宇段请求地址:/session/field/findAII响应10000成功f -1系统错误，10001必填参数为空响应描述如响应例子请求例子:http://127.0.0.1:8080/session/field/findAII?name=X 响应例子：{\ode H:-10000M f M exception":null f M isSuccess-:true/,message rt：-^ f系统处理正常！"/page":0/pageSize":0/returnObject":null/retumValue•:{"types^null/villages^null/companys^H^conC olour 丫Ticon SizelOJconStyle•:•丁icT:4「name 丫XXXiconColour 丫TiconSizelO/iconStyle•: ■:・icT:5/ nameTXX”},{”iconColourTTiconSize・：（TiconStyle”：・Ticr：7「name・：-X X”}]}「totals・：0}2文件上传2.1文件上传（ajax）请求地址:/session/file/upload 请求参数formData.append("file M f this.files[O]);$.ajax({url: routePath + "/session/file/upload"ftype : TOST；data : formData,processData : false,contentType : false, success : function (result) {result = JSON.parse(result);if(result.code== -10000M){layer.msg(上传成功！ *);$(M#editHeadPortrait M).val(result.returnValue.filePath);}}});响应例子：returnValue 里包含了fileName 和filePath3字段管理•所属类型3.1新熠所属类型请求地址:/session/fieldType/save响应响应例子：{"code^^lOOOO'/'exception^null/isSuccess^true/'message*:*^^ ,系统处理正箒! "/page^O/pageSize^O/returnListSize^O/returnObject^null/returnValue^null/totals^O}3.2修改所属类型请求地址:/session/fieldType/update 请求参数响应请求例子：http://127.0.0.1:8080/session/fieldType/update?id=2&name二test响应例子：{"code^/lOOOO^'exception^null/isSuccess^true/'message^/fiE% f系统处理正常！•/page":0/pageSize":0/returnListSize B:0/retumObject":null/returnValue R:null r"totals":0}3.3根据id获取所属类型请求: /session/fieldType/getByld 请求参数响应例子：{"code^/lOOOO'/'exception^null/isSuccess^true/^message'/fiJ^t) f 系统处理正常！ "/page H :0/pageSize ,,:0/returnListSize":0/returnObject M :null/returnValue"：rid e :2/',name":,,re -}f H totals ,,:0}3.4获取所属类型列表请求: /session/fieldType/selectAII请数请求例子：http://127.0.0.1:8080/session/fieldType/selectAII?name=l 响应例子：{"code^/lOOOO'/'exception^null/isSuccess^true/'message^'sJ^J f 系统处理正箒! ；-page":0/pageSize":0/returnObject R :null/returnValue\[rid":l ；name\"123"}X"id\6r w name"：-145555"}] /totals":2}3.5删除所属类型（批星）请求地址:/session/fieldType/deleteBylds 请求参数响应例子：{"code^/lOOOO'/'exception^null/isSuccess^true/'message'/fiJ^i] f 系统处理正常！ "/page^O/pageSize^O/retumListSize^O/returnObject^null/returnValue^null/totals^O}。

API接口文档

API接口文档最后更新日期：2013-05-16一、添加域名接口 (6)1、接口调用地址 (6)2、传入参数 (6)3、输出数据 (6)二、删除域名接口 (7)1、接口调用地址 (7)2、传入参数 (7)3、输出数据 (7)三、添加用户接口 (8)1、接口调用地址 (8)2、传入参数 (8)3、输出数据 (8)四、获取用户信息接口 (9)1、接口调用地址 (9)2、传入参数 (9)3、输出数据 (9)五、搜索用户接口 (10)1、接口调用地址 (10)2、传入参数 (10)3、输出数据 (10)六、修改用户接口 (11)1、接口调用地址 (11)2、传入参数 (11)3、输出数据 (12)七、删除用户接口 (13)1、接口调用地址 (13)2、传入参数 (13)3、输出数据 (13)八、获取邮箱别名接口 (14)1、接口调用地址 (14)2、传入参数 (14)3、输出数据 (14)九、获取部门列表接口 (15)1、接口调用地址 (15)2、传入参数 (15)3、输出数据 (15)十、添加部门接口 (17)1、接口调用地址 (17)3、输出数据 (17)十一、修改部门接口 (18)1、接口调用地址 (18)2、传入参数 (18)3、输出数据 (18)十二、删除部门接口 (19)1、接口调用地址 (19)2、传入参数 (19)3、输出数据 (19)十三、获取部门成员接口 (20)1、接口调用地址 (20)2、传入参数 (20)3、输出数据 (20)十四、添加部门成员接口 (21)1、接口调用地址 (21)2、传入参数 (21)3、输出数据 (21)十五、删除部门成员接口 (22)1、接口调用地址 (22)2、传入参数 (22)3、输出数据 (22)十六、添加别名接口 (23)1、接口调用地址 (23)2、传入参数 (23)3、输出数据 (23)十七、修改别名接口 (24)1、接口调用地址 (24)2、传入参数 (24)3、输出数据 (24)十八、删除别名接口 (25)1、接口调用地址 (25)2、传入参数 (25)3、输出数据 (25)十九、获取POP接收邮件接口 (26)1、接口调用地址 (26)2、传入参数 (26)3、输出数据 (26)二十、添加POP接收邮件接口 (27)1、接口调用地址 (27)2、传入参数 (27)3、输出数据 (27)二十一、修改POP接收邮件接口 (28)1、接口调用地址 (28)3、输出数据 (28)二十二、删除POP接收邮件接口 (29)1、接口调用地址 (29)2、传入参数 (29)3、输出数据 (29)二十三、获取邮件列表接口 (30)1、接口调用地址 (30)2、传入参数 (30)3、输出格式 (30)二十四、查看邮件接口 (31)1、调用方式 (31)2、传入参数 (31)3、输出格式 (31)二十五、客户端连机检测接口 (32)1、接口调用地址 (32)2、传入参数 (32)3、输出数据 (32)二十六、单点登录 (33)1、登录方法 (33)2、传入参数 (34)二十七、冻结/解冻用户帐号接口 (36)1、接口调用地址 (36)2、传入参数 (36)3、输出数据 (36)二十八、获取冻结用户帐号接口 (37)1、调用方式 (37)2、传入参数 (37)3、输出格式 (37)二十九、获取显示已存在的邮件列表接口 (37)1、调用方式 (37)2、传入参数 (37)3、输出格式 (37)三十、添加邮件列表接口 (38)1、调用方式 (38)2、传入参数 (38)3、输出格式 (38)三十一、修改邮件列表接口 (38)1、调用方式 (38)2、传入参数 (39)3、输出格式 (39)三十二、删除邮件列表接口 (39)1、调用方式 (39)3、输出格式 (39)三十三、显示邮件列表成员接口 (40)1、调用方式 (40)3、输出格式 (40)三十四、添加邮件列表成员接口 (40)1、调用方式 (40)2、传入参数 (41)3、输出格式 (41)三十五、删除邮件列表成员接口 (41)1、调用方式 (41)2、传入参数 (41)3、输出格式 (41)三十六、更新邮件列表成员属性接口 (42)1、调用方式 (42)2、传入参数 (42)3、输出格式 (42)三十七、获取个人通讯录分组列表* (42)1、调用方式 (42)2、传入参数 (42)3、输出格式 (43)三十八、获取个人通讯录指定分组下的联系人列表* (43)1、调用方式 (43)2、传入参数 (43)3、输出格式 (44)三十九、获取个人通讯录联系人信息* (44)1、调用方式 (44)2、传入参数 (45)3、输出格式 (45)四十、添加个人通讯录分组* (46)1、调用方式 (46)2、传入参数 (46)3、输出格式 (46)四十一、修改个人通讯录分组* (47)1、调用方式 (47)2、传入参数 (47)3、输出格式 (47)四十二、删除个人通讯录分组* (48)1、调用方式 (48)2、传入参数 (48)3、输出格式 (48)四十三、添加联系人* (48)1、调用方式 (48)2、传入参数 (49)3、输出格式 (49)四十四、修改联系人* (50)1、调用方式 (50)2、传入参数 (50)3、输出格式 (51)四十五、删除联系人* (51)1、调用方式 (51)2、传入参数 (51)3、输出格式 (51)四十六、添加联系人分组信息* (52)1、调用方式 (52)2、传入参数 (52)3、输出格式 (53)四十七、删除联系人分组信息* (53)1、调用方式 (53)2、传入参数 (53)3、输出格式 (54)一、添加域名接口1、接口调用地址http://domain/webmail/api/addDomain.php?adminpass=xxx&domain=&quota=1 5000&userlimit=150&userquota=100&netfilequota=50&allowreg=on&created=2009-04 -23&ended=2013-01-01&password=1234562、传入参数需要以GET方式传递以下参数：●adminpass: 超级管理员MD5后的密码●domain: 要添加的域名，例如“”●quota: 此域的空间限额，单位为M。

腾讯对外接口API文档

打开以下网址，输入您的腾讯绑定帐号以及密码：/index.php/API%E6%96%87%E6%A1%A3类似这样的：API文档返回出自腾讯微博开放平台跳转到：导航, 搜索OAuth授权时间线微博相关帐户相关关系链相关私信相关搜索相关热度，趋势数据更新相关数据收藏话题相关标签相关名单微群相关邀请相关LBS相关其他文档更新历史API问题QA错误码说明表情列表下载OAuth授权request_token 获取request_tokenauthorize 用户授权request_tokenaccess_token 交换access_tokenaccess_token 交换access_token点击查看示例API请求示例说明auth/get_oauth2_token 通过oAuth1.0的token获取oAuth2.0的token时间线statuses/home_timeline 主页时间线statuses/public_timeline 广播大厅时间线statuses/user_timeline 其他用户发表时间线statuses/mentions_timeline 用户提及时间线statuses/ht_timeline 话题时间线(建议使用新话题时间线接口ht_timeline_ext) statuses/broadcast_timeline 我发表时间线statuses/special_timeline 特别收听的人发表时间线statuses/area_timeline 地区发表时间线statuses/home_timeline_ids 主页时间线索引statuses/user_timeline_ids 其他用户发表时间线索引statuses/broadcast_timeline_ids 我发表时间线索引statuses/mentions_timeline_ids 用户提及时间线索引statuses/users_timeline 多用户发表时间线statuses/users_timeline_ids 多用户发表时间线索引statuses/ht_timeline_ext 话题时间线statuses/home_timeline_vip 拉取vip用户发表微博消息接口statuses/sub_re_list 获取二传手列表（获取转播或评论的再次转播或评论列表）微博相关t/show 获取一条微博数据t/add 发表一条微博t/del 删除一条微博t/re_add 转播一条微博t/reply 回复一条微博（即对话）t/add_pic 发表一条带图片的微博t/re_count 转播数或点评数t/re_list 获取单条微博的转发或点评列表t/comment 点评一条微博t/add_music 发表音乐微博t/add_video 发表视频微博t/getvideoinfo 获取视频信息t/list 根据微博id批量获取微博内容（与索引合起来用）t/sub_re_count 获取转播的再次转播数（二次转发次数)t/add_emotion 发表心情帖子t/add_pic_url 用图片URL发表带图片的微博t/add_multi 多类型发表（可同时发表带音频、视频、图片的微博）帐户相关user/info 获取自己的详细资料user/update 更新用户信息user/update_head 更新用户头像信息user/update_edu 更新用户教育信息user/other_info 获取其他人资料user/infos 获取一批人的简单资料user/verify 验证账户是否合法（是否注册微博）user/emotion 获取心情微博关系链相关friends/fanslist 我的听众列表friends/fanslist_name 我的听众列表，只输出namefriends/idollist 我收听的人列表friends/idollist_name 我收听的人列表，只输出namefriends/blacklist 黑名单列表friends/speciallist 特别收听列表friends/add 收听某个用户friends/del 取消收听某个用户friends/addspecial 特别收听某个用户friends/delspecial 取消特别收听某个用户friends/addblacklist 添加某个用户到黑名单friends/delblacklist 从黑名单中删除某个用户friends/check 检测是否我的听众或收听的人friends/user_fanslist 其他帐户听众列表friends/user_idollist 其他帐户收听的人列表friends/user_speciallist 其他帐户特别收听的人列表friends/fanslist_s 我的听众列表，简单信息（200个）friends/idollist_s 我的收听列表，简单信息（200个）friends/mutual_list 互听关系链列表friends/match_nick_tips 好友账号及昵称输入提示私信相关private/add 发私信private/del 删除一条私信private/recv 收件箱private/send 发件箱搜索相关search/user 搜索用户search/t 搜索微博search/userbytag 通过标签搜索用户热度，趋势trends/ht 话题热榜trends/t 转播热榜trends/famouslist 推荐名人列表数据更新相关info/update 查看数据更新条数数据收藏fav/addt 收藏一条微博fav/delt 取消收藏一条微博fav/list_t 收藏的微博列表fav/addht 订阅话题fav/delht 取消订阅话题fav/list_ht 获取已订阅话题列表话题相关ht/ids 根据话题名称查询话题idht/info 根据话题id获取话题相关信息标签相关tag/add 添加标签tag/del 删除标签名单list/list_followers 名单订阅成员列表信息list/myfollowlist 我订阅的名单信息list/create 创建名单list/delete 删除名单list/edit 修改名单list/get_list 查询我创建的名单list/check_user_in_list 筛选指定的用户是否在名单中list/list_attr 名单属性信息list/follow 订阅多个名单list/undo_follow 取消订阅多个名单list/add_to_list 收录指定用户到名单list/del_from_list 从名单中删除指定用户list/get_other_in_list 查询指定用户所在的所有listlist/listusers 查询名单成员列表list/list_info 查询指定微博用户的名单相关信息微群相关weiqun/add 在微群中发表微博消息weiqun/apply4group 申请加入微群weiqun/bindqqgroup 微群与Q群互绑定weiqun/del 删除微群中的微博weiqun/home_timeline 微群主页时间线weiqun/multihome_timeline 多微群主页时间线weiqun/quitgroup 退出微群weiqun/setbulletin 设置微群公告weiqun/setmemattr 设置微群成员属性邀请相关invite/get_invite_list 获取好友列表invite/event_invite 发送好友邀请LBS相关LBS相关接口使用说明文档lbs/update_pos 更新地理位置lbs/del_pos 删除最后更新位置lbs/get_poi 获取POI(Point of Interest)lbs/get_around_new 获取身边最新的微博lbs/get_around_people 获取身边的人其他other/kownperson 我可能认识的人other/shorturl 短url变长urlother/videokey 获取视频上传的keyother/get_emotions 获取表情接口other/gettopreadd 一键转播热门排行other/follower_trans_conv 拉取我收听的用户的转播消息接口other/quality_trans_conv 拉取精华转播消息接口other/vip_trans_conv 拉取vip用户的转播消息接口other/url_converge 短url聚合other/gettopiczbrank 同话题热门转播排行文档更新历史API问题QA错误码说明表情列表下载取自“/index.php/API%E6%96%87%E6%A1%A3”帐户相关/取消收听某个用户返回出自腾讯微博开放平台跳转到：导航, 搜索目录[隐藏]∙ 1 请求说明∙ 2 参数说明∙ 3 使用说明∙ 4 返回结果∙ 5 字段说明请求说明url /api/friends/del格式xml,jsonhttp请求方式post是否需要鉴权true请求数限制true关于请求数限制，参见接口访问权限说明参数说明请求参数：oauth或openid&openkey标准参数，并带上以下参数format 返回数据的格式（json或xml）name 他人的帐户名（可选）他人的openid（可选）fopenidname和fopenid至少选一个，若同时存在则以name值为主使用说明/api/friends/delpost包体格式为：format=json&name=xxxx&fopenid=xxxx返回结果{ret:0,msg:"ok",errcode:0}字段说明ret: 返回值，0-成功，非0-失败msg:错误信息errcode:返回错误码errcode:发表失败错误码参看文档最后说明，点击此处查看取自“/index.php/%E5%B8%90%E6%88%B7%E7%9B%B8%E5%85%B3/%E5 %8F%96%E6%B6%88%E6%94%B6%E5%90%AC%E6%9F%90%E4%B8%AA%E7%94%A8%E6%88%B 7”。

api接口说明文档模板文

api接口说明文档模板文API是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力今天小编给大家整理了api知识供大家参考，我们一起来看看吧!api接口说明文档模板1API：应用程序接口(API：Application Program Interface)应用程序接口是一组定义、程序及协议的集合，通过API 接口实现计算机软件之间的相互通信。

API 的一个主要功能是提供通用功能集。

程序员通过调用API 函数对应用程序进行开发，可以减轻编程任务。

API 同时也是一种中间件，为各种不同平台提供数据共享。

根据单个或分布式平台上不同软件应用程序间的数据共享性能，可以将 API 分为四种类型：远程过程调用(RPC)：通过作用在共享数据缓存器上的过程(或任务)实现程序间的通信。

标准查询语言(SQL)：是标准的访问数据的查询语言，通过数据库实现应用程序间的数据共享。

文件传输：文件传输通过发送格式化文件实现应用程序间数据共享。

信息交付：指松耦合或紧耦合应用程序间的小型格式化信息，通过程序间的直接通信实现数据共享。

当前应用于 API 的标准包括 ANSI 标准 SQL API。

另外还有一些应用于其它类型的标准尚在制定之中。

API 可以应用于所有计算机平台和操作系统。

这些 API 以不同的格式连接数据(如共享数据缓存器、数据库结构、文件框架)。

每种数据格式要求以不同的数据命令和参数实现正确的数据通信，但同时也会产生不同类型的错误。

因此，除了具备执行数据共享任务所需的知识以外，这些类型的API 还必须解决很多网络参数问题和可能的差错条件，即每个应用程序都必须清楚自身是否有强大的性能支持程序间通信。

相反由于这种API 只处理一种信息格式，所以该情形下的信息交付API 只提供较小的命令、网络参数以及差错条件子集。

正因为如此，交付API 方式大大降低了系统复杂性，所以当应用程序需要通过多个平台实现数据共享时，采用信息交付 API 类型是比较理想的选择。

Leanpub API接口文档说明书

Package‘leanpubr’October13,2022Version0.3.1Title'Leanpub'API InterfaceDescription Provides access to the'Leanpub'API<https:///help/api>for gathering information aboutpublications and submissions to the'Leanpub'platform.License GPL-3Imports httr,xml2,jsonliteSuggests knitr,rmarkdown,covr,testthatEncoding UTF-8LazyData trueByteCompile trueType PackageMaintainer John Muschelli<*********************>VignetteBuilder knitrURL https:///muschellij2/leanpubrBugReports https:///muschellij2/leanpubr/issuesRoxygenNote6.1.0NeedsCompilation noAuthor John Muschelli[aut,cre]Repository CRANDate/Publication2018-08-1609:30:05UTCR topics documented:lp_api_key (2)lp_base_url (3)lp_book_info (3)lp_coupons (4)lp_download (5)12lp_api_keylp_get_wrapper (6)lp_job_status (7)lp_links (7)lp_preview (8)lp_publish (9)lp_sales (10)Index11 lp_api_key Find API Key for LeanpubDescriptionDetermines if Leanpub API Key is set.If not,it stops and returns an error.If so,returns the value.Usagelp_api_key(api_key=NULL,error=TRUE)lp_have_api_key(api_key=NULL)Argumentsapi_key Leanpub API key(Sys.getenv( LEANPUB_API_KEY ))error Should the function error if api_key=NULL?ValueCharacter API keyNoteYou can either set the API key or have it accessible by api_key=Sys.getenv( LEANPUB_API_KEY ).Examplesres=lp_api_key(error=FALSE)lp_have_api_key()lp_base_url3 lp_base_url Leanpub Base URLDescriptionLeanpub Base URLUsagelp_base_url(secure=TRUE)Argumentssecure Should https be used(may be necessary)ValueCharacter vector(length1)of URLExampleslp_base_url()lp_book_info Leanpub Book InformationDescriptionLeanpub Book InformationUsagelp_book_info(slug,api_key=NULL,secure=TRUE,verbose=TRUE,...)lp_summary(slug,api_key=NULL,secure=TRUE,verbose=TRUE,...) Argumentsslug slug of the projectapi_key API key for Leanpub,passed to lp_api_keysecure passed to lp_base_url for httpsverbose print diagnostic messages...additional options to pass to GET4lp_coupons ValueList of the result of the GET call and the contentNoteSee https:///help/apiExamplesif(lp_have_api_key()){stat=lp_book_info(slug="modernscientist")}lp_coupons Leanpub CouponsDescriptionLeanpub CouponsUsagelp_coupons(slug,api_key=NULL,secure=TRUE,verbose=TRUE,...) Argumentsslug slug of the projectapi_key API key for Leanpub,passed to lp_api_keysecure passed to lp_base_url for httpsverbose print diagnostic messages...additional options to pass to GETValueList of the result of the GET call and the contentNoteSee https:///help/apilp_download5 lp_download Leanpub Download Latest VersionDescriptionLeanpub Download Latest VersionUsagelp_download(slug,format=c("pdf","mobi","epub"),api_key=NULL,secure=TRUE,verbose=TRUE,...)Argumentsslug slug of the projectformat format of the book to downloadapi_key API key for Leanpub,passed to lp_api_keysecure passed to lp_base_url for httpsverbose print diagnostic messages...additional options to pass to GETValueList of the result of the GET call and the contentNoteSee https:///help/apiExamplesif(lp_have_api_key()){slug="biostatmethods"res=lp_download(slug,verbose=FALSE,nonstop=TRUE,error=FALSE,format="mobi")file.exists(res)}6lp_get_wrapper lp_get_wrapper Leanpub Wrapper for GET/POST statementsDescriptionLeanpub Wrapper for GET/POST statementsUsagelp_get_wrapper(slug,endpoint,api_key=NULL,secure=TRUE,verbose=TRUE,...)lp_post_wrapper(slug,endpoint,api_key=NULL,secure=TRUE,verbose=TRUE,...)Argumentsslug slug of the projectendpoint call to the api endpointapi_key API key for Leanpub,passed to lp_api_keysecure passed to lp_base_url for httpsverbose print diagnostic messages...additional options to pass to GETValueList of the result of the GET call and the contentNoteSee https:///help/apiExamplesif(lp_have_api_key()){stat=lp_get_wrapper(slug="neuroimagingforstatisticians",endpoint="/job_status",nonstop=TRUE,error=FALSE)}lp_job_status7 lp_job_status Leanpub Job StatusDescriptionLeanpub Job StatusUsagelp_job_status(slug,api_key=NULL,secure=TRUE,verbose=TRUE,...)Argumentsslug slug of the projectapi_key API key for Leanpub,passed to lp_api_keysecure passed to lp_base_url for httpsverbose print diagnostic messages...additional options to pass to GETValueList of the result of the GET call and the contentNoteSee https:///help/apiExamplesif(lp_have_api_key()){stat=lp_job_status(slug="neuroimagingforstatisticians",nonstop=TRUE,error=FALSE)}lp_links Leanpub LinksDescriptionLeanpub LinksUsagelp_links(slug,api_key=NULL,secure=TRUE,verbose=TRUE,...)8lp_previewArgumentsslug slug of the projectapi_key API key for Leanpub,passed to lp_api_keysecure passed to lp_base_url for httpsverbose print diagnostic messages...additional options to pass to GETValueList of URLsNoteSee https:///help/apiExamplesif(lp_have_api_key()){slug="biostatmethods"res=lp_links(slug,nonstop=TRUE,error=FALSE)}lp_preview Leanpub PreviewDescriptionLeanpub PreviewUsagelp_preview(slug,api_key=NULL,secure=TRUE,verbose=TRUE,...) Argumentsslug slug of the projectapi_key API key for Leanpub,passed to lp_api_keysecure passed to lp_base_url for httpsverbose print diagnostic messages...additional options to pass to GETValueList of the result of the GET call and the contentlp_publish9NoteSee https:///help/apiExamplesif(lp_have_api_key()){slug="neuroimagingforstatisticians"res=lp_preview(slug,nonstop=FALSE,error=FALSE)}lp_publish Leanpub PublishDescriptionLeanpub PublishUsagelp_publish(slug,api_key=NULL,secure=TRUE,verbose=TRUE,...) Argumentsslug slug of the projectapi_key API key for Leanpub,passed to lp_api_keysecure passed to lp_base_url for httpsverbose print diagnostic messages...additional options to pass to GETValueList of the result of the GET call and the contentNoteSee https:///help/apiExamplesif(lp_have_api_key()){slug="neuroimagingforstatisticians"res=lp_publish(slug,nonstop=TRUE,error=FALSE)}10lp_sales lp_sales Leanpub Sales InformationDescriptionLeanpub Sales InformationUsagelp_sales(slug,api_key=NULL,secure=TRUE,verbose=TRUE,...)lp_all_sales(slug,api_key=NULL,secure=TRUE,verbose=TRUE,...)Argumentsslug slug of the projectapi_key API key for Leanpub,passed to lp_api_keysecure passed to lp_base_url for httpsverbose print diagnostic messages...additional options to pass to GETValueList of the result of the GET call and the contentNoteSee https:///help/apiExamplesif(lp_have_api_key()){lp_all_sales(slug="biostatmethods",query=list(page=2))}IndexGET,3–10lp_all_sales(lp_sales),10lp_api_key,2,3–10lp_base_url,3,3,4–10lp_book_info,3lp_coupons,4lp_download,5lp_get_wrapper,6lp_have_api_key(lp_api_key),2lp_job_status,7lp_links,7lp_post_wrapper(lp_get_wrapper),6lp_preview,8lp_publish,9lp_sales,10lp_summary(lp_book_info),311。

开发接口文档API文档模板

版本控制信息版本日期描绘作者2018-8-13创立XXX获得全部字段1.1获得全部字段恳求地点：/session/field/findAll恳求参数参数名必填字段种类描绘name 是String 依据名称挑选响应code 10000成功，-1系统错误，10001必填参数为空message 响应描绘result 如响应例子恳求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统办理正常！","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":nu ll,"companys":[{"iconColour":"","iconSize":0,"iconStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize": 0,"iconStyle":"","id":5,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"tot als":0}文件上传2.1文件上传（ajax）恳求地点：/session/file/upload恳求参数参数名必填字段种类描绘file 是FormData FormData对象包括的文件响应code 10000成功，-1系统错误，10001必填参数为空message 响应描绘result 如响应例子恳求例子：varformData=newFormData(); ("file",[0]);$.ajax({url:routePath+"/session/file/upload", type:'POST',data:formData,processData:false,contentType:false,success:function(result){result=(result);if=="10000"){ ('上传成功！');editHeadPortrait").val} }});响应例子：returnValue 里包括了fileName 和filePath字段管理-所属种类3.1新增所属种类恳求地点：/session/fieldType/save恳求参数参数名必填字段种类描绘name 是String 所属种类名称响应code 10000成功，-1系统错误，10001必填参数为空message 响应描绘result 如响应例子恳求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统办理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"to tals":0}3.2改正所属种类恳求地点：/session/fieldType/update恳求参数参数名必填字段种类描绘id 是Long 所属种类idname 是String 所属种类名称响应code 10000成功，-1系统错误，10001必填参数为空message 响应描绘result 如响应例子恳求例子：&name=test响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":" 成功，系统办理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"to tals":0}3.3依据id获得所属种类恳求地点：/session/fieldType/getById恳求参数参数名必填字段种类描绘id 是Long 所属种类id响应code 10000成功，-1系统错误，10001必填参数为空message 响应描绘result 如响应例子恳求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统办理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":{"id":2, "name":"re"},"totals":0}3.4获得所属种类列表恳求地点：/session/fieldType/selectAll恳求参数参数名必填字段种类描绘name 否String 依据种类名称挑选响应code 10000成功，-1系统错误，10001必填参数为空message 响应描绘result 如响应例子恳求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统办理正常！","page":0,"pageSize":0,"returnObject":null,"returnValue":[{"id":1,"name":"123"},{"id ":6,"name":"145555"}],"totals":2}3.5删除所属种类（批量）恳求地点：/session/fieldType/deleteByIds恳求参数参数名必填字段种类描绘ids 是List 所属种类id会合响应code 10000成功，-1系统错误，10001必填参数为空message 响应描绘result 如响应例子恳求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统办理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"t otals":0}。

汉印云打印开放API 接口文档使用说明书

【汉印云打印】开放API接口文档版本(1.1)2018年10月汉印云打印平台.接口文档V1.1目录1.概述： (1)2.打印接口： (1)2.1API接口地址 (1)2.2API请求方式 (1)2.3API调用方法 (1)2.4系统级和应用级的参数 (2)2.5签名加密算法如下： (3)2.6加密示例： (3)2.7需要传递给API的参数是： (3)3.APP调用功能： (4)3.1添加打印机 (4)3.2删除打印机 (5)3.3打印订单 (6)3.4查询打印机状态 (7)3.5查询打印完成情况 (8)4.内容排版标记参数 (10)5.注意事项 (13)6.版本信息： (14)1.概述：汉印云打印平台是以互联网为基础，整合云打印机资源，构建漫游共享的打印平台，向所有用户提供随时随地高质量、标准化的打印服务，包含了云平台、API、云打印服务器、云打印机等，产品广泛应用于快递业、超市、餐饮、社区店、生鲜店等，并致力于成为国内一线互联网云平台。

本文档提供了面向互联网开放的API接口，可有效的实现汉印云打印平台和应用开发者之间的对接，帮助用户和开发者方便地使用云平台的架构和功能。

2.打印接口：本节介绍如何发送数据到汉印云API并通过云平台输出打印指令，以及对应的状态返回码。

2.1API接口地址/api/values2.2API请求方式POST2.3API调用方法发送打印数据到汉印云API请求以及参数应该用POST方法发送。

汉印云API将根据收到的信息验证请求的有效性反馈对应的状态码。

2.4系统级和应用级的参数发送打印数据到汉印云请求必须包含以下参数（系统级参数和应用级参数）。

系统级参数应用级参数2.5签名加密算法如下：Sign=MD5（UserID+PrinterNo+TimeStamp+ApiKey)，串在一起后进行MD5加密然后再转成大写，括号里面的参数只需要传入值。

2.6加密示例：000001hcs100171600521498469357ED93DC463FA44A7F8BD1919AE282C 310这是未加密前串在一起的排列，然后把这串字符进行MD5加密得到的结果就是sign的值Sign=MD5（UserID+PrinterNo+TimeStamp+ApiKey)2.7需要传递给API的参数是：UserID、PrinterNo、TimeStamp这3个参数是需要提交给API的。

电商管理后台API接口文档

电商管理后台API接⼝⽂档1. 电商管理后台 API 接⼝⽂档1.1. API V1 接⼝说明接⼝基准地址：http://127.0.0.1:8888/api/private/v1/服务端已开启 CORS 跨域⽀持API V1 认证统⼀使⽤ Token 认证需要授权的 API ，必须在请求头中使⽤ Authorization 字段提供 token 令牌使⽤ HTTP Status Code 标识状态数据返回格式统⼀使⽤ JSON1.1.1. ⽀持的请求⽅法GET（SELECT）：从服务器取出资源（⼀项或多项）。

POST（CREATE）：在服务器新建⼀个资源。

PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。

PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。

DELETE（DELETE）：从服务器删除资源。

HEAD：获取资源的元数据。

OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

1.1.2. 通⽤返回状态说明状态码含义说明200OK请求成功201CREATED创建成功204DELETED删除成功400BAD REQUEST请求的地址不存在或者包含不⽀持的参数401UNAUTHORIZED未授权403FORBIDDEN被禁⽌访问404NOT FOUND请求的资源不存在422Unprocesable entity[POST/PUT/PATCH] 当创建⼀个对象时，发⽣⼀个验证错误500INTERNAL SERVER ERROR内部错误1.2. 登录1.2.1. 登录验证接⼝请求路径：login请求⽅法：post请求参数参数名参数说明备注username⽤户名不能为空password密码不能为空响应参数参数名参数说明备注id⽤户 IDrid⽤户⾓⾊ IDusername⽤户名mobile⼿机号email邮箱token令牌基于 jwt 的令牌响应数据{"data": {"id": 500,"rid": 0,"username": "admin","mobile": "123","email": "123@","token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1aWQiOjUwMCwicmlkIjowLCJpYXQiOjE1MTI1NDQyOTksImV4cCI6MTUxMjYzMDY5OX0.eGrsrvwHm-tPsO9r_pxHIQ5i5L1kX9RX444uwnRGaIM"},"meta": {"msg": "登录成功","status": 200}}1.3. ⽤户管理1.3.1. ⽤户数据列表请求路径：users请求⽅法：get请求参数参数名参数说明备注query查询参数可以为空pagenum当前页码不能为空pagesize每页显⽰条数不能为空响应参数参数名参数说明备注totalpage总记录数pagenum当前页码users⽤户数据集合响应数据{"data": {"totalpage": 5,"pagenum": 4,"users": [{"id": 25,"username": "tige117","mobile": "186********","type": 1,"email": "tige112@","create_time": "2017-11-09T20:36:26.000Z","mg_state": true, // 当前⽤户的状态"role_name": "炒鸡管理员"}]},"meta": {"msg": "获取成功","status": 200}}1.3.2. 添加⽤户请求路径：users请求⽅法：post请求参数参数名参数说明备注username⽤户名称不能为空password⽤户密码不能为空email邮箱可以为空mobile⼿机号可以为空响应参数参数名参数说明备注id⽤户 IDrid⽤户⾓⾊ IDusername⽤户名mobile⼿机号email邮箱响应数据{"data": {"id": 28,"username": "tige1200","mobile": "test","type": 1,"openid": "","email": "test@","create_time": "2017-11-10T03:47:13.533Z","modify_time": null,"is_delete": false,"is_active": false},"meta": {"msg": "⽤户创建成功","status": 201}}1.3.3. 修改⽤户状态请求路径：users/:uId/state/:type请求⽅法：put请求参数参数名参数说明备注uId⽤户 ID不能为空携带在url中type⽤户状态不能为空携带在url中，值为 true 或者 false 响应数据{"data": {"id": 566,"rid": 30,"username": "admin","mobile": "123456","email": "bb@","mg_state": 0},"meta": {"msg": "设置状态成功","status": 200}}1.3.4. 根据 ID 查询⽤户信息请求路径：users/:id请求⽅法：get请求参数参数名参数说明备注id⽤户 ID不能为空携带在url中响应参数参数名参数说明备注id⽤户 IDrole_id⾓⾊ IDmobile⼿机号email邮箱响应数据{"data": {"id": 503,"username": "admin3","role_id": 0,"mobile": "00000","email": "new@"},"meta": {"msg": "查询成功","status": 200}}1.3.5. 编辑⽤户提交请求路径：users/:id请求⽅法：put请求参数参数名参数说明备注id⽤户 id不能为空参数是url参数:idemail邮箱可以为空mobile⼿机号可以为空响应参数参数名参数说明备注id⽤户 IDrole_id⾓⾊ IDmobile⼿机号email邮箱响应数据/* 200表⽰成功，500表⽰失败 */{"data": {"id": 503,"username": "admin3","role_id": 0,"mobile": "111","email": "123@"},"meta": {"msg": "更新成功","status": 200}}1.3.6. 删除单个⽤户请求路径：users/:id请求⽅法：delete请求参数参数名参数说明备注id⽤户 id不能为空参数是url参数:id响应参数响应数据{"data": null,"meta": {"msg": "删除成功","status": 200}}1.3.7. 分配⽤户⾓⾊请求路径：users/:id/role请求⽅法：put请求参数参数名参数说明备注id⽤户 ID不能为空参数是url参数:idrid⾓⾊ id不能为空参数body参数响应参数参数名参数说明备注id⽤户 IDrole_id⾓⾊ IDmobile⼿机号email邮箱响应数据{"data": {"id": 508,"rid": "30","username": "asdf1","mobile": "123123","email": "adfsa@"},"meta": {"msg": "设置⾓⾊成功","status": 200}}1.4. 权限管理1.4.1. 所有权限列表请求路径：rights/:type请求⽅法：get参数名参数说明备注type类型值 list 或 tree , list 列表显⽰权限, tree 树状显⽰权限,参数是url参数:type 响应参数参数名参数说明备注id权限 IDauthName权限说明level权限层级pid权限⽗ IDpath对应访问路径响应数据 type=list{"data": [{"id": 101,"authName": "商品管理","level": "0","pid": 0,"path": null},{"id": 102,"authName": "订单管理","level": "0","pid": 0,"path": null}],"meta": {"msg": "获取权限列表成功","status": 200}}type=tree{data: [{id: 101,authName: '商品管理',path: null,pid: 0,children: [{id: 104,authName: '商品列表',path: null,pid: 101,children: [{id: 105,authName: '添加商品',path: null,pid: '104,101'}]}]}],meta: {msg: '获取权限列表成功',status: 200}}1.4.2. 左侧菜单权限请求路径：menus请求⽅法：get响应数据{"data":{"id": 101,"authName": "商品管理","path": null,"children": [{"id": 104,"authName": "商品列表","path": null,"children": []}]}"meta": {"msg": "获取菜单列表成功","status": 200}}1.5. ⾓⾊管理1.5.1. ⾓⾊列表请求路径：roles请求⽅法：get响应数据说明第⼀层为⾓⾊信息第⼆层开始为权限说明，权限⼀共有 3 层权限最后⼀层权限，不包含 children 属性响应数据{"data": [{"id": 30,"roleName": "主管","roleDesc": "技术负责⼈","children": [{"id": 101,"authName": "商品管理","path": null,"children": ["id": 104,"authName": "商品列表","path": null,"children": [{"id": 105,"authName": "添加商品","path": null}]}]}]}],"meta": {"msg": "获取成功","status": 200}}1.5.2. 添加⾓⾊请求路径：roles请求⽅法：post请求参数参数名参数说明备注roleName⾓⾊名称不能为空roleDesc⾓⾊描述可以为空响应参数参数名参数说明备注roleId⾓⾊ IDroleName⾓⾊名称roleDesc⾓⾊描述响应数据{"data": {"roleId": 40,"roleName": "admin2","roleDesc": "admin2Desc"},"meta": {"msg": "创建成功","status": 201}}1.5.3. 根据 ID 查询⾓⾊请求路径：roles/:id请求⽅法：get请求参数参数名参数说明备注:id⾓⾊ ID不能为空携带在url中响应参数参数名参数说明备注roleId⾓⾊ IDroleName⾓⾊名称roleDesc⾓⾊描述响应数据{"data": {"roleId": 31,"roleName": "测试⾓⾊","roleDesc": "测试负责⼈"},"meta": {"msg": "获取成功","status": 200}}1.5.4. 编辑提交⾓⾊请求路径：roles/:id请求⽅法：put请求参数参数名参数说明备注:id⾓⾊ ID不能为空携带在url中roleName⾓⾊名称不能为空roleDesc⾓⾊描述可以为空响应数据{"data": {"roleId": 31,"roleName": "测试⾓⾊","roleDesc": "测试⾓⾊描述"},"meta": {"msg": "获取成功","status": 200}}1.5.5. 删除⾓⾊请求路径：roles/:id请求⽅法：delete请求参数响应数据{"data": null, "meta": {"msg": "删除成功", "status": 200 }}1.5.6. ⾓⾊授权请求路径：roles/:roleId/rights 请求⽅法：post请求参数：通过请求体发送给后端响应数据{"data": null, "meta": {"msg": "更新成功", "status": 200 }}1.5.7. 删除⾓⾊指定权限请求路径：roles/:roleId/rights/:rightId 请求⽅法：delete 请求参数响应数据说明返回的data, 是当前⾓⾊下最新的权限数据响应数据{"data": [ {"id": 101,"authName": "商品管理", "path": null, "children": [ {"id": 104,"authName": "商品列表", "path": null, "children": [ {"id": 105,"authName": "添加商品", "path": null }, {"id": 116,"authName": "修改", "path": null } ] } ] } ],"meta": {"msg": "取消权限成功", "status": 200 }}1.6. 商品分类管理1.6.1. 商品分类数据列表请求路径：categories 请求⽅法：get 请求参数响应参数响应数据{"data": [ {"cat_id": 1,"cat_name": "⼤家电", "cat_pid": 0, "cat_level": 0,"cat_deleted": false, "children": [ {"cat_id": 3,"cat_name": "电视",参数名参数说明备注:id⾓⾊ ID不能为空携带在url 中参数名参数说明备注:roleId ⾓⾊ ID不能为空携带在url 中rids权限 ID 列表（字符串）以 , 分割的权限 ID 列表（获取所有被选中、叶⼦节点的key 和半选中节点的key, 包括 1，2，3级节点）参数名参数说明备注:roleId ⾓⾊ ID 不能为空携带在url 中:rightId权限 ID不能为空携带在url 中参数名参数说明备注type [1,2,3]值：1，2，3 分别表⽰显⽰⼀层⼆层三层分类列表【可选参数】如果不传递，则默认获取所有级别的分类pagenum 当前页码值【可选参数】如果不传递，则默认获取所有分类pagesize每页显⽰多少条数据【可选参数】如果不传递，则默认获取所有分类参数名参数说明备注cat_id 分类 ID cat_name 分类名称cat_pid 分类⽗ ID cat_level分类当前层级"cat_pid": 1,"cat_level": 1,"cat_deleted": false,"children": [{"cat_id": 6,"cat_name": "曲⾯电视","cat_pid": 3,"cat_level": 2,"cat_deleted": false},{"cat_id": 7,"cat_name": "海信","cat_pid": 3,"cat_level": 2,"cat_deleted": false}]}]}],"meta": {"msg": "获取成功","status": 200}}1.6.2. 添加分类请求路径：categories请求⽅法：post请求参数参数名参数说明备注cat_pid分类⽗ ID不能为空，如果要添加1级分类，则⽗分类Id应该设置为 0 cat_name分类名称不能为空cat_level分类层级不能为空，0表⽰⼀级分类；1表⽰⼆级分类；2表⽰三级分类响应数据{"data": {"cat_id": 62,"cat_name": "相框","cat_pid": "1","cat_level": "1"},"meta": {"msg": "创建成功","status": 201}}1.6.3. 根据 id 查询分类请求路径：categories/:id请求⽅法：get请求参数参数名参数说明备注:id分类 ID不能为空携带在url中响应数据{"data": {"cat_id": 3,"cat_name": "厨卫电器","cat_pid": 0,"cat_level": 0},"meta": {"msg": "获取成功","status": 200}}1.6.4. 编辑提交分类请求路径：categories/:id请求⽅法：put请求参数参数名参数说明备注:id分类 ID不能为空携带在url中cat_name分类名称不能为空【此参数，放到请求体中】响应数据{"data": {"cat_id": 22,"cat_name": "⾃拍杆","cat_pid": 7,"cat_level": 2},"meta": {"msg": "更新成功","status": 200}}1.6.5. 删除分类请求路径：categories/:id请求⽅法：delete请求参数参数名参数说明备注:id分类 ID不能为空携带在url中响应数据{"data": null,"meta": {"msg": "删除成功","status": 200}}1.7. 分类参数管理1.7.1. 参数列表请求路径：categories/:id/attributes请求⽅法：get请求参数参数名参数说明备注:id分类 ID不能为空携带在url中sel[only,many]不能为空,通过 only 或 many 来获取分类静态参数还是动态参数响应参数参数名参数说明备注attr_id分类参数 IDattr_name分类参数名称cat_id分类参数所属分类attr_sel only:输⼊框(唯⼀) many:后台下拉列表/前台单选框attr_write manual:⼿⼯录⼊ list:从列表选择attr_vals如果 attr_write:list,那么有值，该值以逗号分隔响应数据{"data": [{"attr_id": 1,"attr_name": "cpu","cat_id": 22,"attr_sel": "only","attr_write": "manual","attr_vals": "ffff"}],"meta": {"msg": "获取成功","status": 200}}1.7.2. 添加动态参数或者静态属性请求路径：categories/:id/attributes请求⽅法：post请求参数参数名参数说明备注:id分类 ID不能为空携带在url中attr_name参数名称不能为空attr_sel[only,many]不能为空attr_vals如果是 many 就需要填写值的选项，以逗号分隔【可选参数】响应数据{"data": {"attr_id": 44,"attr_name": "测试参数","cat_id": "1","attr_sel": "many","attr_write": "list","attr_vals": "a,b,c"},"meta": {"msg": "创建成功","status": 201}}1.7.3. 删除参数请求路径： categories/:id/attributes/:attrid请求⽅法：delete请求参数参数名参数说明备注:id分类 ID不能为空携带在url中:attrid参数 ID不能为空携带在url中响应数据{"data": null,"meta": {"msg": "删除成功","status": 200}}1.7.4. 根据 ID 查询参数请求路径：categories/:id/attributes/:attrId请求⽅法：get请求参数参数名参数说明备注:id分类 ID不能为空携带在url中:attrId属性 ID不能为空携带在url中attr_sel[only,many]不能为空attr_vals如果是 many 就需要填写值的选项，以逗号分隔响应数据{"data": {"attr_name": "cpu","cat_id": 22,"attr_sel": "only","attr_write": "manual","attr_vals": "ffff"},"meta": {"msg": "获取成功","status": 200}}1.7.5. 编辑提交参数请求路径：categories/:id/attributes/:attrId请求⽅法：put请求参数参数名参数说明备注:id分类 ID不能为空携带在url中:attrId属性 ID不能为空携带在url中attr_name新属性的名字不能为空，携带在请求体中attr_sel属性的类型[many或only]不能为空，携带在请求体中attr_vals参数的属性值可选参数，携带在请求体中响应数据{"data": {"attr_id": 9,"attr_name": "测试更新","cat_id": "43","attr_sel": "only","attr_write": "manual","attr_vals": "abc"},"meta": {"msg": "更新成功","status": 200}}1.8. 商品管理1.8.1. 商品列表数据请求路径：goods请求⽅法：get请求参数参数名参数说明备注query查询参数可以为空pagenum当前页码不能为空pagesize每页显⽰条数不能为空响应参数参数名参数说明备注total总共商品条数pagenum当前商品页数goods_id商品 IDgoods_name商品名称goods_price价格goods_number数量goods_weight重量不能为空goods_state商品状态商品状态 0: 未通过 1: 审核中 2: 已审核add_time添加时间upd_time更新时间hot_mumber热销品数量is_promote是否是热销品响应数据{"data": {"total": 50,"pagenum": "1","goods": [{"goods_id": 144,"goods_name": "asfdsd","goods_price": 1,"goods_number": 1,"goods_weight": 1,"goods_state": null,"add_time": 1512954923,"upd_time": 1512954923,"hot_mumber": 0,"is_promote": false}]},"meta": {"msg": "获取成功","status": 200}}1.8.2. 添加商品请求路径：goods请求参数参数名参数说明备注goods_name商品名称不能为空goods_cat以为','分割的分类列表不能为空goods_price价格不能为空goods_number数量不能为空goods_weight重量不能为空goods_introduce介绍可以为空pics上传的图⽚临时路径（对象）可以为空attrs商品的参数（数组），包含动态参数和静态属性可以为空请求数据{"goods_name":"test_goods_name2","goods_cat": "1,2,3","goods_price":20,"goods_number":30,"goods_weight":40,"goods_introduce":"abc","pics":[{"pic":"/tmp_uploads/30f08d52c551ecb447277eae232304b8"}],"attrs":[{"attr_id":15,"attr_value":"ddd"},{"attr_id":15,"attr_value":"eee"}]}响应参数参数名参数说明备注total总共商品条数pagenum当前商品页数goods_id商品 IDgoods_cat以为','分割的分类列表goods_name商品名称goods_price价格goods_number数量goods_weight重量不能为空goods_state商品状态商品状态 0: 未通过 1: 审核中 2: 已审核add_time添加时间upd_time更新时间hot_mumber热销品数量is_promote是否是热销品pics上传的图⽚临时路径（对象）pics_id:图⽚ ID,goods_id:商品 ID,pics_big:⼤图,pics_mid:中图,pics_sma:⼩图attrs商品的参数（数组）goods_id:商品 ID,attr_value:当前商品的参数值,add_price:浮动价格,attr_vals:预定义的参数值,attr_sel:⼿动输⼊，还是单选,响应数据{"data": {"goods_id": 145,"goods_name": "test_goods_name2","goods_price": 20,"cat_id": 1,"goods_number": 30,"goods_weight": 40,"goods_introduce": "abc","goods_big_logo": "","goods_small_logo": "","goods_state": 1,"add_time": 1512962370,"upd_time": 1512962370,"hot_mumber": 0,"is_promote": false,"pics": [{"pics_id": 397,"goods_id": 145,"pics_big": "uploads/goodspics/big_30f08d52c551ecb447277eae232304b8","pics_mid": "uploads/goodspics/mid_30f08d52c551ecb447277eae232304b8","pics_sma": "uploads/goodspics/sma_30f08d52c551ecb447277eae232304b8"}],"attrs": [{"goods_id": 145,"attr_id": 15,"attr_value": "ddd","add_price": null,"attr_name": "fffffff","attr_sel": "many","attr_write": "list","attr_vals": ""},{"goods_id": 145,"attr_id": 15,"attr_value": "eee","add_price": null,"attr_name": "fffffff","attr_sel": "many","attr_write": "list","attr_vals": ""}]},"meta": {"msg": "创建商品成功","status": 201}}1.8.3. 根据 ID 查询商品请求路径：goods/:id请求⽅法：get请求参数参数名参数说明备注id商品 ID不能为空携带在url中响应参数参数名参数说明备注total总共商品条数pagenum当前商品页数goods_id商品 IDgoods_name商品名称goods_price价格goods_number数量goods_weight重量不能为空goods_state商品状态商品状态 0: 未通过 1: 审核中 2: 已审核add_time添加时间upd_time更新时间hot_mumber热销品数量is_promote是否是热销品pics上传的图⽚临时路径（对象）pics_id:图⽚ ID,goods_id:商品 ID,pics_big:⼤图,pics_mid:中图,pics_sma:⼩图attrs商品的参数（数组）goods_id:商品 ID,attr_value:当前商品的参数值,add_price:浮动价格,attr_vals:预定义的参数值,attr_sel:⼿动输⼊，还是单选,响应数据{"data": {"goods_id": 145,"goods_name": "test_goods_name2","goods_price": 20,"goods_number": 30,"goods_weight": 40,"goods_introduce": "abc","goods_big_logo": "","goods_small_logo": "","goods_state": 1,"add_time": 1512962370,"upd_time": 1512962370,"hot_mumber": 0,"is_promote": false,"pics": [{"pics_id": 397,"goods_id": 145,"pics_big": "uploads/goodspics/big_30f08d52c551ecb447277eae232304b8","pics_mid": "uploads/goodspics/mid_30f08d52c551ecb447277eae232304b8","pics_sma": "uploads/goodspics/sma_30f08d52c551ecb447277eae232304b8"}],"attrs": [{"goods_id": 145,"attr_id": 15,"attr_value": "ddd","add_price": null,"attr_name": "fffffff","attr_sel": "many","attr_write": "list","attr_vals": ""},{"goods_id": 145,"attr_id": 15,"attr_value": "eee","add_price": null,"attr_name": "fffffff","attr_sel": "many","attr_write": "list","attr_vals": ""}]},"meta": {"msg": "创建商品成功","status": 201}}1.8.4. 编辑提交商品请求路径：goods/:id请求⽅法：put请求参数参数名参数说明备注id商品 ID不能为空携带在url中goods_name商品名称不能为空goods_price价格不能为空goods_number数量不能为空goods_weight重量不能为空goods_introduce介绍可以为空pics上传的图⽚临时路径（对象）可以为空attrs商品的参数（数组）可以为空请求数据{"goods_name":"test_goods_name2","goods_price":20,"goods_number":30,"goods_weight":40,"goods_introduce":"abc","pics":[{"pic":"/tmp_uploads/30f08d52c551ecb447277eae232304b8"}],"attrs":[{"attr_id":15,"attr_value":"ddd"},{"attr_id":15,"attr_value":"eee"}]}响应参数参数名参数说明备注total总共商品条数pagenum当前商品页数goods_id商品 IDgoods_name商品名称goods_price价格goods_number数量goods_weight重量不能为空goods_state商品状态商品状态 0: 未通过 1: 审核中 2: 已审核add_time添加时间upd_time更新时间hot_mumber热销品数量is_promote是否是热销品pics上传的图⽚临时路径（对象）pics_id:图⽚ ID,goods_id:商品 ID,pics_big:⼤图,pics_mid:中图,pics_sma:⼩图attrs商品的参数（数组）goods_id:商品 ID,attr_value:当前商品的参数值,add_price:浮动价格,attr_vals:预定义的参数值,attr_sel:⼿动输⼊，还是单选,响应数据{"data": {"goods_id": 145,"goods_name": "test_goods_name2","goods_price": 20,"goods_number": 30,"goods_weight": 40,"goods_introduce": "abc","goods_big_logo": "","goods_small_logo": "","goods_state": 1,"add_time": 1512962370,"upd_time": 1512962370,"hot_mumber": 0,"is_promote": false,"pics": [{"pics_id": 397,"goods_id": 145,"pics_big": "uploads/goodspics/big_30f08d52c551ecb447277eae232304b8","pics_mid": "uploads/goodspics/mid_30f08d52c551ecb447277eae232304b8","pics_sma": "uploads/goodspics/sma_30f08d52c551ecb447277eae232304b8"}],"attrs": [{"goods_id": 145,"attr_id": 15,"attr_value": "ddd","add_price": null,"attr_name": "fffffff","attr_sel": "many","attr_write": "list","attr_vals": ""},{"goods_id": 145,"attr_id": 15,"attr_value": "eee","add_price": null,"attr_name": "fffffff","attr_sel": "many","attr_write": "list","attr_vals": ""}]},"meta": {"msg": "创建商品成功","status": 201}}1.8.5. 删除商品请求路径：goods/:id请求⽅法：delete请求参数参数名参数说明备注id商品 ID不能为空携带在url中响应数据{"data": null,"meta": {"msg": "删除成功","status": 200}}###同步商品图⽚请求路径：goods/:id/pics请求⽅法：put请求参数参数名参数说明备注id商品 ID不能为空携带在url中pics商品图⽚集合如果有 pics_id 字段会保留该图⽚，如果没有 pics_id 但是有 pic 字段就会新⽣成图⽚数据请求数据;[{ pic: 'tmp_uploads/db28f6316835836e97653b5c75e418be.png' },{pics_id: 397,goods_id: 145,pics_big: 'uploads/goodspics/big_30f08d52c551ecb447277eae232304b8',pics_mid: 'uploads/goodspics/mid_30f08d52c551ecb447277eae232304b8',pics_sma: 'uploads/goodspics/sma_30f08d52c551ecb447277eae232304b8'}]响应数据{"data": {"goods_id": 96,"goods_name": "iphoneXX","goods_price": 2,"goods_number": 22,"goods_weight": 22,"goods_introduce": null,"goods_big_logo": "./uploads/goods/20171113/483a3b8e99e534ec3e4312dbbaee7c9d.jpg","goods_small_logo": "./uploads/goods/20171113/small_483a3b8e99e534ec3e4312dbbaee7c9d.jpg","goods_state": 0,"is_del": "1","add_time": 1510045904,"upd_time": 1512635159,"delete_time": 1512635159,"hot_mumber": 0,"is_promote": false,"pics": [{"pics_id": 383,"goods_id": 96,"pics_big": "uploads/goodspics/big_6f5750132abd3f5b2b93dd722fcde653.jpg","pics_mid": "uploads/goodspics/mid_6f5750132abd3f5b2b93dd722fcde653.jpg","pics_sma": "uploads/goodspics/sma_6f5750132abd3f5b2b93dd722fcde653.jpg"}],"attrs": [{"goods_id": 96,"attr_id": 15,"attr_value": "eee","add_price": null,"attr_name": "fffffff","attr_sel": "many","attr_write": "list","attr_vals": ""},{"goods_id": 96,"attr_id": 15,"attr_value": "ddd","add_price": null,"attr_name": "fffffff","attr_sel": "many","attr_write": "list","attr_vals": ""}]},"meta": {"msg": "更新成功","status": 200}}###同步商品属性请求路径：goods/:id/attributes请求⽅法：put请求参数参数名参数说明备注id商品 ID不能为空携带在url中请求数据;[{attr_id: 15,attr_value: 'ddd'},{attr_id: 15,attr_value: 'eee'}]{"data": {"goods_id": 96,"goods_name": "iphoneXX","goods_price": 2,"goods_number": 22,"goods_weight": 22,"goods_introduce": null,"goods_big_logo": "./uploads/goods/20171113/483a3b8e99e534ec3e4312dbbaee7c9d.jpg","goods_small_logo": "./uploads/goods/20171113/small_483a3b8e99e534ec3e4312dbbaee7c9d.jpg","goods_state": 0,"is_del": "1","add_time": 1510045904,"upd_time": 1512635159,"delete_time": 1512635159,"hot_mumber": 0,"is_promote": false,"pics": [{"pics_id": 383,"goods_id": 96,"pics_big": "uploads/goodspics/big_6f5750132abd3f5b2b93dd722fcde653.jpg","pics_mid": "uploads/goodspics/mid_6f5750132abd3f5b2b93dd722fcde653.jpg","pics_sma": "uploads/goodspics/sma_6f5750132abd3f5b2b93dd722fcde653.jpg"}],"attrs": [{"goods_id": 96,"attr_id": 15,"attr_value": "eee","add_price": null,"attr_name": "fffffff","attr_sel": "many","attr_write": "list","attr_vals": ""},{"goods_id": 96,"attr_id": 15,"attr_value": "ddd","add_price": null,"attr_name": "fffffff","attr_sel": "many","attr_write": "list","attr_vals": ""}]},"meta": {"msg": "更新成功","status": 200}}###商品图⽚处理必须安装 GraphicsMagicklinuxapt-get install GraphicsMagickMac OS Xbrew install GraphicsMagickWindows1.9. 图⽚上传请求路径：upload请求⽅法：post请求参数参数名参数说明备注file上传⽂件响应数据{"data": {"tmp_path": "tmp_uploads/ccfc5179a914e94506bcbb7377e8985f.png","url": "http://127.0.0.1:8888tmp_uploads/ccfc5179a914e94506bcbb7377e8985f.png"},"meta": {"msg": "上传成功","status": 200}}1.10. 订单管理1.10.1. 订单数据列表请求路径：orders请求⽅法：get请求参数参数名参数说明备注query查询参数可以为空pagenum当前页码不能为空pagesize每页显⽰条数不能为空user_id⽤户 ID可以为空pay_status⽀付状态可以为空is_send是否发货可以为空order_fapiao_title['个⼈','公司']可以为空order_fapiao_company公司名称可以为空order_fapiao_content发票内容可以为空consignee_addr发货地址可以为空响应数据{"data": {"total": 1,"pagenum": "1",。

1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。

接口：
接口泛指实体把自己提供给外界的一种抽象化物，用以由内部操作分离出外部沟通方法，使其能被内部修改而不影响外界其他实体与其交互的方式。

在计算机中，接口是计算机系统中两个独立的部件进行信息交换的共享边界。

这种交换可以发生在计算机软、硬件，外部设备或进行操作的人之间，也可以是它们的结合。

API：
API是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。

用来提供应用程序与开发人员基于某软件或硬件得以访问的一组例程，而又无需访问源码，或理解内部工作机制的细节。

简介：
操作系统是用户与计算机硬件系统之间的接口，用户通过操作系统的帮助，可以快速、有效和安全、可靠地操纵计算机系统中的各类资源，以处理自己的程序。

为使用户能方便地使用操作系统，OS 又向用户提供了如下两类接口：
用户接口：操作系统专门为用户提供了“用户与操作系统的接口” ，通常称为用户接口。

该接口支持用户与OS 之间进行交互，即由用户向OS 请求提供特定的服务，而系统则把服务的结果返回给用户。

程序接口：操作系统向编程人员提供了“程序与操作系统的接口” ，简称程序接口，又称应用程序接口API。

该接口是为程序员
在编程时使用的，系统和应用程序通过这个接口，可在执行中访问系统中的资源和取得OS 的服务，它也是程序能取得操作系统服务的唯一途径。

大多数操作系统的程序接口是由一组系统调用(system call)组成，每一个系统调用都是一个能完成特定功能的子程序。

应用程序接口又称为应用编程接口，是一组定义、程序及协议的集合，通过API接口实现计算机软件之间的相互通信。