上线日期：2021/07/07
版本说明：
1、所有接口：新增 lang 传入参数，支持 繁体中文 返回结果。
2、获取分类指定章节内容接口：新增 referrer_id 传入参数，以实现不同 referrer 分别统计浏览量。
3、搜索接口：新增 author 返回字段，以实现搜索该作者所有章节内容功能。
4、搜索接口：根据传入 lang 参数搜索对应语言数据库，并返回搜索结果，与传入 kw 参数所使用语言无关。
5、v2版本视频清晰度、分辨率进行了升级，1.0版本视频地址及接口将于一段时间后停止维护，请使用 1.0版本的朋友们尽快升级。（已停止维护）
| 描述 | 名称 | 参数 | 示例 | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 接口返回数据统一格式 | |||||||||||||||||||||
| 说明 |
本版本所有接口返回数据均遵循此格式。 返回一个 json 对象，包含以下字段： { "code": 返回码 "msd": 返回消息 "data": 返回数据 } 返回码：
|
||||||||||||||||||||
| 获取 所有分类目录 | categories | lang={lang_id} | 举例 | ||||||||||||||||||
| 说明 |
{lang_id} lang_id 为语言id，表明该接口应以何种语言返回数据。 该参数支持 zh-hans（简体中文）和 zh-hant（繁体中文）。 该参数为可选项，若未传入则该接口默认返回 简体中文 数据。 返回一个 json 数组，每个 json 对象包含以下字段： { "cate_id": 分类id "cate_name": 分类名称 "cate_class_id": 分类类别id "cate_class_name": 分类类别名称 }
|
||||||||||||||||||||
| 获取 指定分类目录 | contents | cate_id={cate_id}&lang={lang_id} | 举例 | ||||||||||||||||||
| 说明 |
{cate_id} cate_id 为分类编号，具体请查阅 获取所有分类目录 接口返回数据。 {lang_id} lang_id 为语言id，表明该接口应以何种语言返回数据。 该参数支持 zh-hans（简体中文）和 zh-hant（繁体中文）。 该参数为可选项，若未传入则该接口默认返回 简体中文 数据。 返回一个 json 对象，包含以下字段： { "cate_id": 分类id, "cate_name": 分类名称 "contents": [目录列表（json数组）] } 目录列表 contents 数组包含以下字段： { "chapter_id": 章节id, "title": 章节标题 "author": 章节作者 } |
||||||||||||||||||||
| 获取 分类中指定章节内容 | contents | cate_id={cate_id}&chapter_id={chapter_id}&referrer_id={referrer_id}&lang={lang_id} | 举例 | ||||||||||||||||||
| 说明 |
{cate_id} cate_id 为分类编号，具体请查阅 获取所有分类目录 接口返回数据。 {chapter_id} chapter_id 为章节编号，具体请查阅 获取指定分类目录 接口返回数据。 {referrer_id} referrer_id 为调用者标识，可为调用者提供独立的浏览量计数。 该参数可由任意字母（不区分大小写）、数字、下划线、小数点组成，长度小于等于32个字符。 该参数为可选项，若未传入则该接口不返回 pageview 字段。 注：以上“举例”传入 referrer_id=fojiaotv_api 仅为举例用，实际调用请使用自拟 referrer_id。 {lang_id} lang_id 为语言id，表明该接口应以何种语言返回数据。 该参数支持 zh-hans（简体中文）和 zh-hant（繁体中文）。 该参数为可选项，若未传入则该接口默认返回 简体中文 数据。 返回一个 json 对象，包含以下字段： { "cate_id": 分类id, "cate_name": 分类名称 "cate_total": 分类章节总数 "chapter_id": 章节id "title": 章节标题 "author": 章节作者 "audio_url": 音频播放地址 "cover_url": 视频封面地址 "video_url": 视频播放地址 "content": 章节正文内容 "pageview": 章节浏览量（需正确传入 referrer_id 参数，否则返回无此字段） } |
||||||||||||||||||||
| 全文搜索 | search | kw={keyword}&size={size}&from={from}&lang={lang_id}&source_id={source_id}&cate_id={cate_id} | 举例 | ||||||||||||||||||
| 说明 |
{keyword} keyword 为搜索关键字。 {size} size 为搜索结果返回数量，该参数为可选项，若未传入则默认为10。 {from} from 为搜索结果返回起始值，该参数为可选项，若未传入则默认为0。 {lang_id} lang_id 为语言id，表明应该搜索何种语言的数据内容。 该参数支持 zh-hans（简体中文）和 zh-hant（繁体中文）。 该参数为可选项，若不传入则默认搜索 简体中文 数据内容。 {source_id} （此参数供合作网站填写使用） source_id 为数据来源的网站id，表明搜索范围仅限来源于该网站的数据。 该参数为可选项，若不传入则默认搜索本站（佛教公开课）数据内容。 本接口支持为佛教网站应用提供独立数据搜索服务，如需合作欢迎来函：support@fojiaotv.net 返回一个 json 对象，包含以下字段： { "total": 搜索到的结果总数 "keyword": 搜索关键字 "size": 搜索结果返回数量 "from": 搜索结果返回起始值 "results": [搜索结果（json数组）] } 搜索结果 results 数组包含以下字段： { "cate_id": 分类id "cate_name": 分类名称 "chapter_id": 章节id "title": 章节标题，关键字高亮 "author": 章节作者，关键字高亮 "content": 含有搜索关键字的正文内容，关键字高亮 } {cate_id} 当 source_id 不传入时，默认搜索本站（佛教公开课）数据内容， 此时可传入 cate_id 专辑编号参数，以搜索指定专辑中的内容。 例如传入 a01，可指定搜索《三乘菩提之意涵》专辑中的内容。 |