跳到主要内容

API 接入 / FIELD NOTES

md2wechat API 快速开始:5 分钟跑通 Markdown 转公众号 HTML

如果你现在最需要的是先调通一次接口,这篇文章会给你最短路径:拿 key、发请求、看结果、排查第一类错误。

如果你现在的目标很明确:

先把 Markdown 成功转成公众号可用 HTML。

那最短路径其实只有 4 步:

  1. 拿到 API Key
  2. 选一种请求头传进去
  3. 传最小请求体
  4. 看返回结果是不是 code: 0

这篇文章不讲大而全,只讲怎么最快调通。

第一步:先准备什么?

你至少需要两样东西:

  • 一个可用的 API Key
  • 一段最简单的 Markdown

先用这段最小 Markdown 就够了:

# 标题

这是一段正文。

如果你现在还没有 key,可以先看这篇:

第二步:认清 3 类 key

现在有 3 类前缀:

  • wme_:旧正式 key
  • wme2_:新正式 key
  • wmt_:试用 key

对你来说,最重要的是这句:

  • 正式接入,优先用 wme2_
  • 临时测试,通常会拿到 wmt_

第三步:发一条最小请求

最简单的做法是直接用 curl

curl -X POST "https://www.md2wechat.cn/api/convert" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: wme2_your_api_key_here" \
  -d '{
    "markdown": "# 标题\n\n这是一段正文。"
  }'

如果你更喜欢另一种请求头,也可以这样:

curl -X POST "https://www.md2wechat.cn/api/convert" \
  -H "Content-Type: application/json" \
  -H "Md2wechat-API-Key: wme2_your_api_key_here" \
  -d '{
    "markdown": "# 标题\n\n这是一段正文。"
  }'

或者用 Bearer:

curl -X POST "https://www.md2wechat.cn/api/convert" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer wme2_your_api_key_here" \
  -d '{
    "markdown": "# 标题\n\n这是一段正文。"
  }'

第四步:看懂返回结果

成功时你会看到类似这样的结构:

{
  "code": 0,
  "msg": "success",
  "data": {
    "html": "<section>...</section>",
    "theme": "default",
    "fontSize": "medium",
    "backgroundType": "default",
    "wordCount": 5,
    "estimatedReadTime": 1
  }
}

先检查这几项:

  • code 只要是 0,说明转换成功
  • data.html 这是转换后的 HTML
  • theme 最终用了哪个主题
  • wordCount 文章字数统计

第五步:最常用的 3 个参数

一开始不要把接口想复杂,最常用的只有这几个:

{
  "markdown": "# 标题\n\n正文",
  "theme": "default",
  "fontSize": "medium",
  "backgroundType": "default"
}

它们分别是:

  • markdown 必填,正文内容
  • theme 可选,不传就用默认主题
  • fontSize 可选,控制字号
  • backgroundType 可选,控制背景样式

如果你想单独把参数讲清楚,继续看:

第六步:第一次调用最容易踩的坑

1. 没传 key

表现:

  • 返回 401
  • 提示缺少 API Key

先查:

  • 你是不是忘了请求头
  • 你是不是把 key 放错了字段名

2. key 前缀不对

现在只支持这 3 类:

  • wme_
  • wme2_
  • wmt_

如果你自己随手改了格式,接口会直接拒绝。

3. 试用 key 已经过期

如果你拿的是 wmt_,而且试用期已经结束,接口会直接提示过期。

这类情况通常是 key 本身失效了。

4. 请求体不是合法 JSON

表现:

  • 返回 400
  • 提示 JSON 请求体不合法

最常见原因:

  • 少了引号
  • 少了逗号
  • Markdown 里的换行没有转义

第七步:推荐的调试顺序

如果你不想一上来就踩坑,最稳的是这个顺序:

  1. 先只传 markdown
  2. 成功后再加 theme
  3. 再加 fontSize
  4. 最后再加 backgroundType

不要一开始就把所有参数都塞进去。
这样一旦报错,你很难知道到底是哪一项出了问题。

第八步:接下来怎么往下走

如果你已经成功跑通一条请求,后面建议这样走:

  1. 再读参数说明,避免主题名和字号传错
  2. 再看常见报错,提前知道 401 和 400 怎么排
  3. 最后再去接你自己的服务端、Agent 或自动化工作流

推荐继续读:

继续阅读

如何获取 md2wechat API Key:正式 key、试用 key、申请前要准备什么

如果你最关心的是怎么拿到 API Key、试用 key 能用多久、正式 key 和试用 key 有什么区别,这篇文章会把申请路径和使用建议一次讲清楚。

正式 key 和试用 key 怎么选?一篇讲清楚什么时候先试用,什么时候直接正式接入

不是所有人都应该先拿试用 key,也不是所有团队都该一上来申请正式 key。这篇文章会把选择标准拆开,让你根据自己的阶段判断应该走哪条路。

md2wechat 新手入门:从安装到第一篇微信公众号草稿

从下载二进制、运行 config init,到把 Markdown 预览成微信 HTML,再到推送草稿箱,这篇文章按真实顺序带你走一遍。

YOUR NEXT ARTICLE

让下一篇文章,从清楚的排版开始。

先看效果,再把稳定的排版能力接入你的工作流。

md2wechat API 快速开始:5 分钟跑通 Markdown 转公众号 HTML