跳到主要内容

网站对接API

版本：v1.0

更新时间：2025-10-30

文档说明​

本文档面向用户网站的开发者，说明如何在用户自己的网站上开发接口，以便接收来自如此 AI 平台的文章推送。

对接流程​

  1. 用户在如此 AI 平台生成文章内容
  2. 用户在自己的网站实现以下 4 个 API 接口（本文档内容）
  3. 用户在如此 AI 平台配置对接信息（网站域名、授权 Token、API 地址）
  4. 如此 AI 平台自动调用用户网站的 API，推送文章内容

认证方式​

如此 AI 平台在调用您的接口时，会在 HTTP Header 中携带您配置的授权 Token：

Authorization: Bearer {YOUR_TOKEN}
  • 您的接口需要验证此 Token 是否正确。
  • Token 长度要求: 6~255 字符

统一响应格式​

您的接口必须返回 JSON 格式，结构如下：

{
  "code": 0,
  "message": "success",
  "data": {}
}

字段说明：

  • code: 0 表示成功，非 0 表示失败
  • message: 提示信息，成功时为 "success"，失败时返回错误原因
  • data: 业务数据对象

接口 1：获取网站配置​

接口说明​

如此 AI 平台会调用此接口，获取您网站的分类、标签、作者等配置信息，用于生成文章时的选项。

接口地址​

GET /api/cms/config （路径可自定义）

如此 AI 平台调用示例​

curl -X GET "https://www.yoursite.com/api/cms/config" \
  -H "Authorization: Bearer your-token-here"

您的接口需要返回的数据​

{
  "code": 0,
  "message": "success",
  "data": {
    "categories": [
      {
        "id": 1,
        "name": "公司新闻",
        "parent_id": 0,
        "children": [
          {
            "id": 2,
            "name": "产品发布",
            "parent_id": 1,
            "children": []
          }
        ]
      },
      {
        "id": 3,
        "name": "行业资讯",
        "parent_id": 0,
        "children": []
      }
    ],
    "tags": ["AI", "技术", "产品", "市场", "SEO"],
    "author": ["张三", "李四", "王五"],
    "is_custom_author": 1
  }
}

字段说明​

字段类型必填说明
categoriesarray是分类列表（树形结构，最多3级）
categories[].idint是分类ID
categories[].namestring是分类名称
categories[].parent_idint是父分类ID（顶级为0）
categories[].childrenarray是子分类列表
tagsarray是标签列表（字符串数组，建议最多10个）
authorarray是作者列表（字符串数组）
is_custom_authorint是是否支持自定义作者（1=支持，0=仅从列表选择）

注意事项​

  • 分类结构最多支持3级，超过3级的会被忽略

接口 2：检查文章是否存在​

接口说明​

如此 AI 平台会调用此接口检查指定ID的文章是否存在于您的网站。

接口地址​

GET /api/article/exists （路径可自定义）

如此 AI 平台调用示例​

curl -X GET "https://www.yoursite.com/api/article/exists?id=273" \
  -H "Authorization: Bearer your-token-here"

如此 AI 平台发送的参数​

字段类型说明
idint/string文章ID（作为查询参数，示例：?id=273）

您的接口需要返回的数据​

{
  "code": 0,
  "message": "success",
  "data": {
    "exists": true
  }
}

返回字段说明​

字段类型说明
existsboolean文章是否存在（true=存在，false=不存在）

接口 3：创建文章​

接口说明​

如此 AI 平台会调用此接口在您的网站创建新文章。

接口地址​

POST /api/article/create （路径可自定义）

如此 AI 平台调用示例​

curl -X POST "https://www.yoursite.com/api/article/create" \
  -H "Authorization: Bearer your-token-here" \
  -H "Content-Type: application/json" \
  -d '{
    "categories": [3, 4],
    "publish_status": 1,
    "title": "如何使用AI写作工具提升内容创作效率",
    "slug": "how-to-use-ai-writing-tools",
    "keywords": ["AI写作", "内容创作", "SEO优化"],
    "author": {
      "name": "如此AI团队"
    },
    "summary": "本文详细介绍了如何使用 AI 写作工具来提升内容创作效率",
    "cover_image": "https://example.com/images/cover.jpg",
    "cover_image_alt": "AI写作工具使用指南",
    "content": "<h2>什么是 AI 写作工具？</h2><p>AI 写作工具是基于人工智能技术的内容生成系统...</p>"
  }'

如此 AI 平台发送的参数​

字段类型必填说明
categoriesarray是分类ID数组
publish_statusint是发布状态（1=已发布，0=草稿）
titlestring是文章标题
slugstring否文章别名/URL路径
keywordsarray否关键词/标签数组（字符串数组）
authorobject否作者信息
author.namestring是作者名称
summarystring否文章摘要
cover_imagestring否封面图片URL（外部链接）
cover_image_altstring否封面图片alt文本
contentstring是文章HTML内容

您的接口需要返回的数据​

{
  "code": 0,
  "message": "success",
  "data": {
    "id": "273",
    "url": "https://www.yoursite.com/blog/how-to-use-ai-writing-tools"
  }
}

返回字段说明​

字段类型说明
idstring/int创建成功的文章ID
urlstring文章访问URL

注意事项​

  • cover_image 是图片链接，存在有效期，所以请直接下载图片并替换为您网站的图片URL
  • content 是 HTML 格式，其中的图片操作同样需要处理为您网站的图片URL
  • 如果分类ID不存在，应返回错误信息

接口 4：更新文章​

接口说明​

如此 AI 平台会调用此接口更新您网站上的已有文章。

接口地址​

POST /api/article/update （路径可自定义）

如此 AI 平台调用示例​

curl -X POST "https://www.yoursite.com/api/article/update" \
  -H "Authorization: Bearer your-token-here" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 273,
    "categories": [3, 4],
    "publish_status": 1,
    "title": "如何使用AI写作工具提升内容创作效率（更新版）",
    "slug": "how-to-use-ai-writing-tools",
    "keywords": ["AI写作", "内容创作", "SEO优化", "营销工具"],
    "author": {
      "name": "如此AI团队"
    },
    "summary": "本文详细介绍了如何使用 AI 写作工具来提升内容创作效率（2025年更新版）",
    "cover_image": "https://example.com/images/cover-v2.jpg",
    "cover_image_alt": "AI写作工具使用指南",
    "content": "<h2>什么是 AI 写作工具？</h2><p>更新后的内容...</p>"
  }'

如此 AI 平台发送的参数​

与"创建文章"接口相同，但必须包含 id 字段，用于指定要更新的文章。

字段类型必填说明
idint/string是要更新的文章ID
其他字段--与创建接口相同

您的接口需要返回的数据​

{
  "code": 0,
  "message": "success",
  "data": {
    "id": "273",
    "url": "https://www.yoursite.com/blog/how-to-use-ai-writing-tools"
  }
}

返回字段说明​

字段类型说明
idstring/int更新后的文章ID
urlstring文章访问URL

注意事项​

  • 如果文章ID不存在，应返回错误（code 非 0）

错误处理​

当操作失败时，您的接口应返回错误信息：

{
  "code": 400,
  "message": "分类ID不存在",
  "data": null
}

建议的错误码​

错误码说明
400请求参数错误（缺少必填字段等）
401Token 验证失败
404资源不存在（如文章ID、分类ID不存在）
500服务器内部错误

在如此 AI 平台配置对接​

开发完接口后，在如此 AI 平台按以下格式配置：

配置信息​

配置项说明示例
网站域名您的网站地址https://www.yoursite.com
授权 Token自定义的认证密钥abc123xyz456
获取配置接口完整URLhttps://www.yoursite.com/api/cms/config
检查文章接口完整URLhttps://www.yoursite.com/api/article/exists
创建文章接口完整URLhttps://www.yoursite.com/api/article/create
更新文章接口完整URLhttps://www.yoursite.com/api/article/update

操作步骤​

图片展示了在如此AI平台添加集成网站的操作界面。左侧导航栏中“集成网站”选项被红色箭头1指向。点击“集成网站”后，进入页面左侧“+添加网站”区域，其中“自定义”选项被红色箭头2指向。点击“自定义”后弹出“选择添加账号平台”窗口，窗口中“自定义”选项被红色箭头3指向。该图片与文档中“在如此AI平台配置对接”部分的操作步骤相关，直观呈现了添加集成网站的步骤。

图片展示了如此AI平台中“如何添加？”页面的“编辑账号平台”弹窗。弹窗内有账号名称、网址、密码等输入框，以及获取CMS配置API、文章存在检查API、文章创建API、文章更新API的示例URL输入框。该图片与文档中“在如此AI平台配置对接”部分上下文对应，直观呈现了配置对接时需填写的账号平台相关信息，帮助开发者了解配置所需填写内容。

技术要求​

  1. 接口协议：HTTP/HTTPS
  2. 请求格式：JSON
  3. 字符编码：UTF-8

常见问题​

Q1: URL 路径必须按文档的来吗？​

A: 不必须。路径可以自定义，只需要在如此 AI 平台配置时填写完整的 URL 即可。

Q2: 是否必须实现所有 4 个接口？​

A: 是的，4 个接口都是必需的。

Q3: 封面图片需要下载到本地吗？​

A: 是的，所有图片文件都需要下载到您自己的网站服务器，并替换为您网站的图片 URL。

Q4: 不支持草稿状态怎么办？​

A: 可以忽略 publish_status 字段，所有文章都按已发布处理。

Q5: 如何测试对接是否成功？​

A: 在如此 AI 平台配置完成后，生成一篇测试文章并推送到您的网站，检查文章是否成功创建。

版权所有 © 如此 AI