要将火龙果写作的文本校对和风格优化能力无缝集成到您的现有开发工作流中——例如在CI/CD流水线中自动检查PR提交的文案质量,或在内网CMS后台实时提示语病——必须绕过网页端手动操作,直接调用其开放API实现结构化交互。下面详细拆解具体步骤,从权限申请到结果解析,手把手带您跑通整个流程。

确认API接入权限与密钥
登录火龙果写作企业版后台,在【开发者中心】→【API管理】中创建新应用,获取 【AppID 和 AppSecret】。请注意:免费试用账号默认不开放API调用权限,需要联系商务开通企业授权后,才会显示“创建应用”按钮。
将生成的 AppID 和 AppSecret 保存为本地环境变量:APP_ID=xxx、APP_SECRET=yyy。切勿硬编码在源码中,否则Git泄露会导致账号被恶意调用,这个细节很多开发者都曾踩过坑。
获取访问令牌(Access Token)
火龙果API所有接口均需携带有效 Access Token,有效期2小时,每次调用前都需要刷新(过期后自动失效,无需担心跨会话泄漏)。
向 https://api.huolongguo.com/oauth2/token 发起 POST 请求,Body 为 x-www-form-urlencoded 格式:
grant_type=client_credentials&client_id={你的AppID}&client_secret={你的AppSecret}
响应成功后提取 JSON 中的 access_token 字段值,后续所有请求的 Authorization Header 必须设置为:Bearer {access_token}。这一步看似简单,但很多人会忘记在Header里添加Bearer前缀,导致401报错。
提交文本进行语法纠错
这里有两种场景,取决于您的文本长度和实时性要求。
方法一:基础校对(同步返回)
向 https://api.huolongguo.com/v1/check 发起 POST 请求,Header 加入 Authorization,Body 为 JSON:
{"text": "今天天气很好,我们一起去公园玩。", "mode": "grammar"}
mode 可选 grammar(语法)、style(风格)、all(全量)。注意:选错 mode 会导致返回字段缺失关键信息,比如如果您只想要语法纠错却选了 style,结果里就不会有“口语化建议”字段。因此请根据实际需求选择,不要直接填 all,除非您确实需要全部功能。
方法二:长文本分块异步处理
单次请求 text 字段最大支持 5000 字符;超长内容需要按句号、问号、感叹号或换行符切分为段落,每段独立调用 /v1/check,然后汇总各段 result,合并 error_list 并去重定位偏移量。还有一个细节:原始文本如果包含 HTML 标签,必须先 strip 或转义,否则解析会失败。这条规则同样适用于富文本编辑器里提取的内容。
解析并提取纠错结果
拿到返回结果后,建议按顺序检查三个关键点:
第一,检查 response.status_code 是否为 200。非200一律视为认证失败或限流,立即暂停重试并记录 error_msg,避免死循环浪费配额。
第二,读取 response.json(),确认 data.result 字段存在且不为空。空 result 表示该文本无问题,但不代表 API 调用失败——需要同时核验 data.code === 0。有些开发者看到空 result 就以为调用失败,其实文本本身没问题,这属于正常响应。
第三,遍历 data.result.error_list 数组,每个 error 对象包含 type(如“主谓不一致”)、pos_start(字符起始位置)、pos_end(字符结束位置)、suggestion(修正建议)。注意:pos_start 和 pos_end 是基于原始 text 的 UTF-8 字符索引,不是字节数。在 Python 中直接 text[pos_start:pos_end] 就能定位错误片段,非常方便。
拿到这些错误信息后,就可以在界面上高亮显示、自动替换,或者集成到CI流程中拒绝合并有严重语病的PR。关键是把 suggestion 作为推荐文案展示给用户,而不是直接替用户改——毕竟机器纠错有时也会误判,保留人工确认环节更稳妥。
