邵阳网站建设优化,wordpress PHP编程,邢台市是几线城市,租赁网站空间API接口文档模板
本文档更新时间#xff1a;2022-12-07
本文档更新说明#xff1a;提供了接口文档模板#xff0c;后续如果有接口文档编写相关工作#xff0c;可以参考该模板。
接口名称#xff1a; XX帐号基础信息批量获取接口 【接口名称#xff0c;见名知意】
接口…API接口文档模板
本文档更新时间2022-12-07
本文档更新说明提供了接口文档模板后续如果有接口文档编写相关工作可以参考该模板。
接口名称 XX帐号基础信息批量获取接口 【接口名称见名知意】
接口版本 v1.0.0 【接口版本号】
接口地址 http://XXX/api/account/get_list_xxx 【接口地址需要拼接URL端口号默认端口号80】
请求方式 GET/POST 【接口的请求方式GET或POST】
请求头Header参数
字段名类型描述app-keystring合作商身份标识api-versionstring请求接口版本号timestampstring接口请求访问时间2022-12-07 19:08:30
【注接口若有请求头Header参数需要填写参数的字段名称、字段类型、该字段的必要文字描述。也可以新添加一列描述字段的默认值。】
请求体Body参数
字段名类型描述pageint页码默认值为1perpageint每页返回账号的数量默认100sortstring排序字段默认为1正序2倒序。支持最多5个字段排序多个排序字段用,隔开例如price_post-1, klr_index-2account_uidstring账号uidmedia_idstring账号唯一标识idfollower_maxint粉丝数上限follower_minint粉丝数下限
【注请求体Body参数中需要填写参数的字段名称、字段类型、该字段的必要文字描述。】
返回参数
字段名类型描述account_uidstring账号UIDaccount_namestring账号昵称account_classstring帐号分类account_followersstring帐号粉丝量media_idint资源中心账号唯一标识IDavatarstring头像的URL链接account_descstring账号描述verified_reasonstring大V认证描述klr_indexint指数article_countint账号博文数量
【注需要介绍接口返回参数中的核心字段如字段名、字段类型、字段描述。】
返回示例
{code: 10000,msg: 请求成功,data: {pagination: {has_next: false,current_page: 1,total_page: 1,total_count: 1,perpage: 100},data: [{account_uid: 1344360230,account_name: Kevin凯文老师,account_class: [美妆时尚],account_followers: 54863320,avatar: http://tvax4.sinaimg.cn/crop.90.414.792.792.180/50214f26ly8g1oaw8s0rrj20u01900x1.jpg,account_desc: 会摄影会做饭、喜欢血拼种草的“彩妆小弟”当然你如果想跟我学英语也是可以的…,verified_reason: 著名造型师 故事红人 签约自媒体,article_count: 14530,klr_index: 89.4,media_id: 740131,}]}
}【注在返回示例的位置粘贴返回的json代码方便看清接口返回的层次信息。】
异常返回示例
{code: 10002,msg: 签名错误,data: []
}【注需要介绍非成功状态下的接口返回示例方便接口调用方做异常处理。】
常见的接口状态返回码
字段描述10000请求成功10001客户端身份异常10002签名错误10003访问次数频繁10004接口参数异常10005接口限制访问
