FimTale API(第一版)说明文档 - FimTale 用户手册及更新公告(所有用户必读注意站内红线)为了简单诸君用户及斥地者更容易调阅FimTale上的消息,一片面页面被以JSON字符串的局势展现正在API当中。这便是FimTale的初版API。

  为缓解站点拜望压力,API仅发放给注册用户。每名依然注册的用户可正在修立页面中获取不众于3个API登录消息。正在提交哀告时,请将APIKey参数与APIPass参数一并附正在哀告外单中提交。请不要过于频仍地应用API拜望本站,对付影响到站点效力的拜望,咱们将探求禁用API所属用户应用API的权限。

  因为API登录消息(APIKey与APIPass)为每个外单必填的参数,以是鄙人文中会省略这两个参数。这两个参数的应用与用户的登录形态无合,即:对付恣意开发,无论是否有效户登录,您都能够应用所申请到的APIKey与APIPass拜望API。

  但与此同时,FimTale也心愿诸君用户隆重治理本身帐号下所天生的API登录消息。若发作吐露,请实时删除该登录消息。对付次数过众乃至于影响到站点平常效力的拜望,FimTale会禁用所属用户的API登录消息应用权限。

  API中的实质片面(作品、便签、评论等)默认的输出为HTML款式,您若须要转markdown款式输出,能够正在所提交外单的查问参数中补上键名为format键值为md的参数,即format=md。

  现在用户对该频道的赞踩记载,null为未赞踩、upvote为赞、downvote为踩

  尺寸small,middle,large)/(标签ID).png

  该作品的审核形态。共有passed(已通过)、pending(待审核)、outside(待提交)三种

  该作品/章节字数。假如是弁言/正文即是作品总字数,假如是章节即是该章节字数。下同

  若不是自界说分支,则唯有一组指向下一章的键值对;假使自界说分支,则有众组键值对,键为按钮中显示的文字,值为按钮按下时跳转到的作品ID

  现在用户正在该作品中的阅读记载,仅正在烘托全文的作品消息中存正在。小于等于0为未发轫阅读,大于等于1为已告竣阅读

  现在用户对该作品的赞踩记载,仅正在烘托全文的作品消息中存正在。null为未赞踩、upvote为赞、downvote为踩

  现在用户对该作品予以的HighPraise个数记载,仅正在烘托全文的作品消息中存正在

  评论所对应的实质类型。topic为作品,channel为频道,blogpost为便签

  仅正在IsDel为0时存正在。现在用户对该作品的赞踩记载。null为未赞踩、upvote为赞、downvote为踩

  该告诉的头像消息。列外中的第一个元素为该头像的类型,avatar为用户头像,icon为图标。若为用户头像,则第二个元素为用户ID;若为图标,则第二个元素为图标类型

  该告诉的附庸实质(即网页版灰框片面的消息)。内含四个键值对:Background为封面,Title为附庸消息的题目,Subtitle为其副题目,Link为其链接。四个值均为String类型

  该告诉的评论消息。内含三个键值对:Type为该实质主体的类型,TargetID为该实质主体的ID,Comments为一个包括少少评论的列外,列内外的评论为含有四个键值对的Map:ID为评论ID,UserID为评论者ID,UserName为评论者用户名,Content为实质

  现在用户的消息。大片面键值对能够参考上面合于用户消息的描写。除此以外,Theme为现在用户所应用的重心,NoPicMode为现在用户是否开启省流形式

  总页面。当总页面不确准时,若有下一页则该值为Page+1,不然为Page

  正在相合便签的列外界面展现。每个元素均为合于便签的消息,其实质能够参考之前的片面

  正在相合频道的列外界面展现。每个元素均为合于频道的消息,其实质能够参考之前的片面

  正在相合标签的列外界面展现。每个元素均为合于标签的消息,其实质能够参考之前的片面

  正在相合作品的列外界面展现。每个元素均为合于作品的消息,其实质能够参考之前的片面

  正在相合用户的列外界面展现。每个元素均为合于用户的消息,其实质能够参考之前的片面

  该便签所相干的实质。其元素为含有众个键值对的Map。Link为所对应网页URL,Cover为封面,Title为实质题目,Subtitle为实质副题目

  团结家目次。其元素为含有两个键值对的Map。UserID为该团结家用户ID,UserName为该团结家用户名

  该频道的话题列外,正在频道话题页面展现。其元素为含有四个键值对的Map。HashTopic为该话落款,Frequency为带有该话题的评论数,LastTime为终末发布且带有该话题的评论的发布时代,LastUser为发布该评论的用户

  假如这篇作品上过编辑精选,这个列内外会展现列次编辑精选的举荐语,每个元素都是包括一次编辑精选作品消息的Map。个中ID为作品ID,Title为作品题目,AuthorID为作家ID,AuthorName为作家用户名,Tags为作品标签,Background为作品封面,RecommenderID为举荐该作的小编ID,RecommenderName为举荐该作的小编用户名,RecommendTime为举荐时代,RecommendWord为举荐语

  该作品前作的消息。其实质能够参考之前作品消息的片面。若无前作,则该值为null

  该作品的续作列外。每个元素均为合于作品的消息,其实质能够参考之前的片面

  包括该作品的频道。每个元素均为合于频道的消息,其实质能够参考之前的片面

  是否含有这名用户。假如为true,则返回用户的消息;为false则返回与该用户名合系的用户列外

  现在的编辑精选列外,每个元素都是包括编辑精选作品消息的Map。个中ID为作品ID,Title为作品题目,AuthorID为作家ID,AuthorName为作家用户名,Tags为作品标签,Background为作品封面,RecommenderID为举荐该作的小编ID,RecommenderName为举荐该作的小编用户名,RecommendTime为举荐时代,RecommendWord为举荐语

  现在的通告列外,每个元素都是通告消息,个中ID为通告对应的作品ID,Title为通告的题目

  上传的URL列外中相合于便签的链接所对应的实质。每个元素均为合于便签的消息,其实质能够参考之前的片面

  上传的URL列外中相合于频道的链接所对应的实质。每个元素均为合于频道的消息,其实质能够参考之前的片面

  上传的URL列外中相合于标签的链接所对应的实质。每个元素均为合于标签的消息,其实质能够参考之前的片面

  上传的URL列外中相合于作品的链接所对应的实质。每个元素均为合于作品的消息,其实质能够参考之前的片面

  上传的URL列外中相合于用户的链接所对应的实质。每个元素均为合于用户的消息,其实质能够参考之前的片面

  (也即是铃铛页面)正在浏览器未获取登录态cookie情形下举办拜望,假使依然附加APIKey与Pass,也会导致跳转至login并返回403