开发者文档

一键排版可以轻松实现一键清除新闻文章中加粗、带色、下划线、斜体、链接、广告、脚本、样式等干扰阅读的元素,将文章一键转换成有更好阅读体验的干净、整洁的段落式新闻文章。一键排版是网络编辑必备的新闻排版、文章排版和网页排版神器。

一键排版 API 系统,旨在为用户提供企业级的稳定性更好的多用户、本地化、跨域的排版服务。

只需要简单接入,您所使用的 HTML 编辑器即可实现与一键排版体验一致的排版功能,从而省去了拷贝和粘贴等动作。

要获得多用户、本地化、跨域的 API 排版许可,您可直接购买 套餐 并完成 API 接入工作即可。

请求

均采用 post 的方式向以下地址发起请求。

排版:POST 至:https://api2.yijianpaiban.com/api/v1/format

简繁转换:POST 至:https://api2.yijianpaiban.com/api/v1/chinese

英文标点转中文:POST 至:https://api2.yijianpaiban.com/api/v1/symbol

全角英文、字母转半角: POST 至:https://api2.yijianpaiban.com/api/v1/sbc2dbc

响应

系统将返回 JSON 格式的排版结果

HTTP 状态码可能有两种: 200(排版正常,返回有效的排版结果)、403(排版异常,返回错误信息)

返回码:返回码只存在于 HTTP 状态码为 403(即排版异常) 的情况下。

code = 4031 即:header 缺少 Authorization 对象

code = 40321 即:header 的 Authorization 对象中缺少 app_key 参数

code = 40322 即:header 的 Authorization 对象中缺少 timestamp 参数

code = 40323 即:header 的 Authorization 对象中缺少 token 参数

code = 4033 即:header 的 Authorization 对象中的 app_key 不正确

code = 4034 即:header 的 Authorization 对象中提供的加密 app_secret 不正确

code = 4035 即:未生效的套餐

code = 4036 即:套餐请求次数已用完

code = 4037 即:套餐有效期已结束

code = 4038 即:请求的字符长度超限

凭据

$app_key = 'string'; //购买套餐后获得

$app_secret = 'long string'; //购买套餐后获得

$timestamp = 15911111111; //时间戳

$token = md5($app_key.$timestamp.$app_secret);

$authorization = base64_encode(json_encode(['app_key'=>$app_key, 'timestamp'=>$timestamp, 'token'=>$token]));

请将 $authorization 凭据通过 header 头的 Authorization 传输给请求地址。

排版请求

POST 地址:https://api2.yijianpaiban.com/api/v1/format

form data:

{content: '文章内容', p_blank: 1, img_center: 1, table_holder:1, link_holder:1, strong_holder: 1}

其中:

p_blank 设置是否段前空格,默认为 0 或 false

img_center 设置是否图片居中,默认为 0 或 false

table_holder 设置是否保留表格,默认为 0 或 false

link_holder 设置是否保留链接,默认为 0 或 false

strong_holder 设置是否保留粗体,默认为 0 或 false

简繁转换请求

POST 地址:https://api2.yijianpaiban.com/api/v1/chinese

form data:

{content: '文章内容', method: '转换方法'}

其中:

method 设置转换的方法,可以是  j2f 即简体转繁体,或 f2j 即繁体转简体。

英文标点转中文

POST 地址:https://api2.yijianpaiban.com/api/v1/symbol

form data:

{content: '文章内容'}

全角英文、数字转半角

POST 地址:https://api2.yijianpaiban.com/api/v1/sbc2dbc

form data:

{content: '文章内容'}