API 开发文档

快速集成微信 Markdown 编辑器 API,实现自动化内容转换和批量处理

快速开始

只需三步,快速接入

  1. 获取 API Key(联系管理员)
  2. 发送 POST 请求到转换接口
  3. 获取微信格式的 HTML 内容

API 基础信息

基础 URL:https://www.md2wechat.com/api
请求方式:POST
内容类型:application/json
速率限制:100 请求/分钟

支持的主题

default - 微信经典风格
bytedance - 字节范科技风
apple - 苹果范视觉渐变
sports - 运动风活力动感
chinese - 中国风古典雅致

API 认证

所有 API 请求都需要有效的 API Key。请在请求头中包含认证信息。

方式一:X-API-Key 请求头

HTTP Header
X-API-Key: wme_your_api_key_here

方式二:Authorization Bearer

HTTP Header
Authorization: Bearer wme_your_api_key_here

如何获取 API Key?

联系极客杰尼获取 API Key。API Key 以 wme_ 前缀开头, 请妥善保管,不要在客户端代码中暴露。

POST /api/convert

将 Markdown 文本转换为微信公众号格式的 HTML。

请求参数

参数名类型必填说明
markdownstring必填要转换的 Markdown 文本内容
themestring可选主题名称,默认为 "default"

请求示例

POST /api/convert
{
  "markdown": "# Hello World\n\n这是一个**加粗**的文本。",
  "theme": "default"
}

成功响应 (200)

Response JSON
{
  "code": 0,
  "msg": "success",
  "data": {
    "html": "<section style=\"...\">...</section>",
    "theme": "default",
    "wordCount": 156,
    "estimatedReadTime": 1
  }
}

代码示例

$
cURL

命令行
curl -X POST "https://www.md2wechat.com/api/convert" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: wme_your_api_key_here" \
  -d '{
    "markdown": "# 标题\n\n这是一个**加粗**文本的例子。",
    "theme": "default"
  }'

JS
JavaScript / Node.js

JavaScript
const response = await fetch('https://www.md2wechat.com/api/convert', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-Key': 'wme_your_api_key_here'
  },
  body: JSON.stringify({
    markdown: '# 标题\n\n这是一个**加粗**文本的例子。',
    theme: 'default'
  })
})

const result = await response.json()
if (result.code === 0) {
  console.log('转换成功:', result.data.html)
} else {
  console.error('转换失败:', result.msg)
}

Py
Python

Python
import requests

url = "https://www.md2wechat.com/api/convert"
headers = {
    "Content-Type": "application/json",
    "X-API-Key": "wme_your_api_key_here"
}
data = {
    "markdown": "# 标题\n\n这是一个**加粗**文本的例子。",
    "theme": "default"
}

response = requests.post(url, headers=headers, json=data)
result = response.json()

if result["code"] == 0:
    print("转换成功:", result["data"]["html"])
else:
    print("转换失败:", result["msg"])

错误处理

常见错误代码

400 - 请求参数错误参数缺失或格式错误
401 - 认证失败API Key 无效或缺失
429 - 请求过于频繁超出速率限制
500 - 服务器错误内部处理异常

错误响应格式

{
  "code": 400,
  "msg": "Markdown content is required."
}

需要帮助?

如需技术支持或查看更多文档,请访问完整的使用帮助页面, 或通过公众号"极客杰尼"联系我们。