API 总览

WNCMS 提供全面的 RESTful API，让您能够以程式化方式与内容管理系统互动。该 API 让您能够建立、读取、更新和删除文章、页面、选单、标签及其他资源。

基础 URL

所有 API 请求应发送至：

https://your-domain.com/api/v1

API 版本

目前 API 版本：v1

版本包含在 URL 路径中，以确保在发布新版本时的向后相容性。

功能特色

文章管理：建立、更新、删除和检索文章，并提供进阶筛选功能
页面管理：管理网站页面
选单管理：同步和检索选单结构
标签管理：建立和管理分类与标签
更新功能：触发和监控系统更新
弹性身份验证：支援多种身份验证方法
统一回应格式：所有端点返回标准化的 JSON 回应
分页支援：列表端点内建分页功能
筛选与排序：资料检索的进阶查询选项

快速开始

取得 API Token：从管理后台的使用者个人资料中产生 API token
发出第一个请求：使用 token 来验证您的 API 呼叫

bash

curl -X GET "https://your-domain.com/api/v1/posts" \
  -H "Content-Type: application/json" \
  -d '{"api_token": "your-api-token-here"}'

处理回应：所有回应都遵循一致的格式

json

{
  "code": 200,
  "status": "success",
  "message": "Successfully fetched posts",
  "data": [...],
  "extra": {}
}

身份验证

WNCMS API 支援多种身份验证方法：

简易验证：在请求主体或查询参数中使用 api_token
基本验证：标准 HTTP 基本验证（在启用时）
无需验证：某些端点可能根据设定公开存取

详细资讯请参阅身份验证。

速率限制

目前 API 没有强制的速率限制。但我们建议在客户端实作您自己的速率限制，以防止过多的请求。

回应格式

所有 API 端点都返回具有以下结构的 JSON 回应：

json

{
  "code": 200,
  "status": "success",
  "message": "Description of the result",
  "data": {},
  "extra": {}
}

更多详情请参阅核心概念。

可用资源

资源	说明	端点
文章	管理部落格文章和文章	`/posts`
页面	管理网站页面	`/pages`
选单	管理导览选单	`/menus`
标签	管理分类和标签	`/tags`
网站	管理网站域名	`/websites`
更新	系统更新操作	`/update`

下一步

入门指南 - 学习如何验证并发出您的第一个 API 呼叫
核心概念 - 了解回应格式、分页和错误处理
API 参考 - 每个端点的详细文件
范例 - 常见用例的程式码范例