将 LemonX 与您自己的系统连接
使用 REST 端点将 LemonX 与 CRM、内部仪表板、报告工具、代理门户、自动化平台和 AI 管道连接。
LemonX REST API 为开发人员提供了一种结构化的方式,将外部工具、仪表板、AI 工作流程、自动化平台和内部系统与 LemonX 驱动的 WordPress 网站连接起来。
使用 API 读取站点上下文、检查内容、创建草稿、触发 AI 工作流程、管理翻译队列、访问 SEO 和 AEO 数据、提交索引请求、检索报告、监控 MCP 活动并将 LemonX 与您自己的系统连接。
WordPress-原生 · 基于 JSON · 权限感知 · 专为 AI、SEO、翻译和自动化工作流程而构建
LemonX REST API 是面向开发人员的接口,用于通过 HTTP 端点与 LemonX 功能进行交互。它允许批准的应用程序、仪表板、自动化工具和 AI 系统请求数据、触发工作流程并以受控方式与 LemonX 模块集成。
虽然 MCP 工具针对使用模型上下文协议的 AI 代理进行了优化,但 REST API 专为构建 Web 应用程序、后端服务、仪表板、脚本、中间件和自动化工作流程的开发人员而设计。
使用 REST 端点将 LemonX 与 CRM、内部仪表板、报告工具、代理门户、自动化平台和 AI 管道连接。
使用真实的 WordPress 内容、元数据、分类法、媒体、用户、语言和插件状态。
创建草稿、排队翻译、生成 SEO 元数据、请求索引、检索报告和监控操作。
API 请求应遵循 WordPress 身份验证、用户能力检查、LemonX 权限和产品授权规则。
最适合开发人员构建的系统、后端集成、仪表板、自动化平台、内部工具和自定义应用程序。
当您想要执行以下操作时,请使用 REST API:
最适合 AI 代理、会话工作流程、Claude Desktop、Codex、Cursor 和其他 MCP 兼容客户端。
当您想要执行以下操作时,请使用 MCP 工具:
REST API 适用于应用程序和系统。 MCP 工具适用于 AI 代理。它们共同使 LemonX 既适合开发人员,又适合 AI 操作。
LemonX REST API 应遵循与 LemonX Suite 相同的模块化结构。每个产品都公开自己的资源,而共享资源则处理身份验证、许可、站点上下文、用户、任务、报告和日志。
站点 API 提供有关 WordPress 安装、活动 LemonX 产品、环境状态、启用的模块和支持的功能的基本信息。
/wp-json/lemonx/v1/site返回基本站点标识和环境详细信息。
/wp-json/lemonx/v1/site/capabilities返回启用的 LemonX 模块和可用的功能组。
/wp-json/lemonx/v1/site/health返回系统运行状况、插件状态、后台任务状态和兼容性说明。
/wp-json/lemonx/v1/site/structure返回公共帖子类型、分类法、语言、模板和内容结构。
内容 API 使开发人员可以访问帖子、页面、草稿、内容大纲、元数据、SEO 字段、结构化内容和发布状态。
/wp-json/lemonx/v1/content列出帖子、页面和支持的自定义帖子类型。
/wp-json/lemonx/v1/content/{id}检索特定内容项。
/wp-json/lemonx/v1/content/drafts创建新草稿。
/wp-json/lemonx/v1/content/{id}/preview-update生成预览更新而不应用更改。
/wp-json/lemonx/v1/content/{id}/apply-update应用批准的更新。
/wp-json/lemonx/v1/content/{id}/outline返回标题、部分结构和内容层次结构。
/wp-json/lemonx/v1/content/search按查询、类型、状态、作者、分类或语言搜索内容。
AEO API 提供对内容优化数据、AI 可见性检查、查询分析、引文跟踪、模式建议、内部链接推荐、索引工作流程和报告的访问。
/wp-json/lemonx/v1/aeo/overview返回 AEO 状态的高级摘要。
/wp-json/lemonx/v1/aeo/analyze分析 URL 或内容项的 SEO 和 AEO 准备情况。
/wp-json/lemonx/v1/aeo/opportunities返回关键字、内容和 AI 搜索机会。
/wp-json/lemonx/v1/aeo/citations返回 AI 引文和品牌提及数据(如果有)。
/wp-json/lemonx/v1/aeo/schema/generate生成结构化数据建议。
/wp-json/lemonx/v1/aeo/internal-links/suggest返回内部链接推荐。
/wp-json/lemonx/v1/aeo/indexing/submit向支持的索引通道提交 URL 。
/wp-json/lemonx/v1/aeo/reports列出可用的 SEO 和 AEO 报告。
Code API 允许外部系统触发页面生成、检索模板、管理草稿、使用知识库上下文、处理 OCR 内容并创建结构化部分。
/wp-json/lemonx/v1/code/templates列出可用的页面和部分模板。
/wp-json/lemonx/v1/code/pages/generate根据提示或结构化摘要生成页面草稿。
/wp-json/lemonx/v1/code/sections/generate生成特定的页面部分。
/wp-json/lemonx/v1/code/briefs创建页面或内容简介。
/wp-json/lemonx/v1/code/knowledge-base列出可用的知识库源。
/wp-json/lemonx/v1/code/knowledge-base/query查询私有知识库上下文。
/wp-json/lemonx/v1/code/ocr/process启用后,通过 OCR 处理上传的文档或图像。
/wp-json/lemonx/v1/code/migration/preview生成旧内容的迁移预览。
Verto API 帮助开发人员对翻译进行排队、检查翻译状态、管理语言、检索翻译内容、更新翻译后的段、生成多语言 SEO 字段并监控翻译进度。
/wp-json/lemonx/v1/verto/languages返回启用的语言和配置。
/wp-json/lemonx/v1/verto/translations/{content_id}返回内容项的翻译状态。
/wp-json/lemonx/v1/verto/queue将内容添加到翻译队列。
/wp-json/lemonx/v1/verto/preview生成或检索翻译预览。
/wp-json/lemonx/v1/verto/apply应用经批准的翻译。
/wp-json/lemonx/v1/verto/seo/generate生成多语言 SEO 标题、元描述和社交字段。
/wp-json/lemonx/v1/verto/slugs/update在支持的情况下更新翻译的 URL slugs。
/wp-json/lemonx/v1/verto/reports返回翻译进度和多语言覆盖率报告。
MCP API 帮助开发人员检查 MCP 连接状态、列出可用工具、检查工具权限、检索活动日志并监控 AI 代理交互。
/wp-json/lemonx/v1/MCP/status返回 MCP 服务器状态和连接准备情况。
/wp-json/lemonx/v1/MCP/tools列出可用的 MCP 工具组。
/wp-json/lemonx/v1/MCP/tools/{tool_name}返回有关特定工具的信息。
/wp-json/lemonx/v1/MCP/logs返回 MCP 活动日志。
/wp-json/lemonx/v1/MCP/permissions返回 MCP 权限配置。
/wp-json/lemonx/v1/MCP/previews/{preview_id}/apply应用已批准的 MCP 预览。
/wp-json/lemonx/v1/MCP/previews/{preview_id}/discard放弃待处理的 MCP 预览。
Pro API 在允许的情况下提供对许可证状态、产品权利、云网关连接、功能可用性、使用指标和订阅相关状态的访问。
/wp-json/lemonx/v1/pro/license返回许可证状态和激活详细信息。
/wp-json/lemonx/v1/pro/entitlements返回已启用的产品权利和计划级功能。
/wp-json/lemonx/v1/pro/usage返回使用数据,例如 AI 调用、翻译使用情况、索引请求或云网关消耗。
/wp-json/lemonx/v1/pro/cloud/status返回云网关状态。
/wp-json/lemonx/v1/pro/license/activate在允许时激活许可证。
/wp-json/lemonx/v1/pro/license/deactivate从当前站点停用许可证。
报告 API 允许开发人员从 LemonX 模块中提取结构化报告数据,并将其显示在仪表板、客户门户、电子邮件或商业智能工具中。
/wp-json/lemonx/v1/reports列出可用的报告类型。
/wp-json/lemonx/v1/reports/seo返回 SEO 和 AEO 摘要数据。
/wp-json/lemonx/v1/reports/content返回内容制作和更新数据。
/wp-json/lemonx/v1/reports/translation返回翻译进度和语言覆盖范围。
/wp-json/lemonx/v1/reports/MCP返回 MCP 活动和 AI 代理使用情况。
/wp-json/lemonx/v1/reports/usage返回计划、API、AI 和云使用情况摘要。
/wp-json/lemonx/v1/reports/export生成可导出的报告草稿。
许多 LemonX 工作流程可以异步运行,包括翻译队列、AI 生成、索引请求、OCR 处理、报告生成和迁移预览。任务 API 帮助开发人员监控这些作业。
/wp-json/lemonx/v1/tasks列出最近的任务。
/wp-json/lemonx/v1/tasks/{task_id}返回任务状态和结果。
/wp-json/lemonx/v1/tasks/{task_id}/cancel支持时取消待处理任务。
/wp-json/lemonx/v1/tasks/queues返回队列运行状况和活动作业计数。
/wp-json/lemonx/v1/tasks/history返回已完成、失败和取消的任务历史记录。
Webhooks API 允许开发人员注册、列出、更新和删除从 LemonX 工作流接收事件的 Webhook 端点。
/wp-json/lemonx/v1/webhooks列出配置的 webhook。
/wp-json/lemonx/v1/webhooks创建 Webhook 订阅。
/wp-json/lemonx/v1/webhooks/{id}返回 webhook 配置。
/wp-json/lemonx/v1/webhooks/{id}更新 webhook 订阅。
/wp-json/lemonx/v1/webhooks/{id}删除 Webhook 订阅。
/wp-json/lemonx/v1/webhooks/{id}/test将测试事件发送到 webhook 端点。
API 应该尊重 WordPress 内容类型、用户、功能、分类法、媒体和插件架构,而不是发明一个断开连接的数据模型。
每个端点都应该检查经过身份验证的用户或应用程序是否有权执行请求的操作。
对于内容更新、SEO 更改、翻译和页面编辑,应在应用更改之前首选预览工作流程。
AEO、Code、Verto、MCP 和 Pro 资源应清晰组织,以便开发人员可以仅启用和使用他们需要的资源。
对于开发人员和 AI 系统来说,响应应该是可预测的、有类型的且友好的。
长时间运行的作业应该返回可以稍后检查的任务引用。
应记录重要操作,以便网站所有者、代理机构和开发人员可以查看发生的情况。
LemonX REST API 身份验证应围绕 WordPress 本机安全性和 LemonX 产品权限进行设计。根据工作流程,开发人员可以使用 WordPress 应用程序密码、经过身份验证的管理会话、API 密钥、类似 OAuth 的流程、云网关凭据或特定于站点的令牌。
对于敏感工作流程,身份验证应与功能检查、随机数验证、产品权利验证和活动日志记录结合起来。
对于服务器到服务器访问和可信集成很有用。
对于管理仪表板交互和基于浏览器的工具很有用。
对于需要专用令牌的选定集成工作流程非常有用。
对于 LemonX Pro 和云连接工作流程很有用。
当 API 操作与 MCP 预览、AI 代理会话或工具执行相关时很有用。
curl -X GET "https://example.com/wp-json/lemonx/v1/site" -H "Authorization: Bearer YOUR_API_TOKEN" -H "Accept: application/json"
{
"site": {
"name": "Example WordPress Site",
"url": "https://example.com",
"WordPress_version": "6.x",
"lemonx_version": "1.x"
},
"products": {
"aeo": true,
"code": true,
"verto": true,
"MCP": true,
"pro": true,
"theme": false
},
"capabilities": [
"content.read",
"content.preview",
"aeo.analyze",
"verto.queue",
"MCP.logs.read"
]
}
端点名称和响应结构应被视为面向开发人员的示例。最终实现细节应与活动的 LemonX 插件版本和文档相匹配。
| 错误 Code | 含义 | 建议采取的行动 |
|---|---|---|
| 无效的请求 | 必填字段缺失或无效 | 检查请求负载 |
| 未经验证的 | 未提供有效的身份验证 | 验证请求 |
| 权限被拒绝 | 用户或令牌缺乏所需的能力 | 检查角色和权限 |
| 产品_非活动状态 | 所需的 LemonX 产品未激活 | 启用产品 |
| 权利要求 | 功能需要 Pro 或更高版本的计划 | 检查许可证和计划 |
| 资源未找到 | 请求的项目不存在 | 验证 ID 或 URL |
| 验证失败 | 负载验证失败 | 检查字段错误 |
| 任务失败 | 后台作业失败 | 检查任务详情 |
| 速率限制 | 请求太多 | 稍后重试或降低频率 |
| 云_不可用 | 云网关不可用 | 检查云状态 |
| 提供商不可用 | AI 或翻译提供商失败 | 重试或使用备份提供商 |
API 工作流程应设计有合理的速率限制,特别是对于 AI 生成、翻译、索引、OCR、报告生成和云连接操作。当缓存或基于任务的响应可用时,开发人员应避免重复调用昂贵的端点。
curl "https://example.com/wp-json/lemonx/v1/content?type=post&page=1&per_page=20"
{
"success": true,
"data": [{ "id": 101, "title": "Example Post", "status": "publish" }],
"pagination": { "page": 1, "per_page": 20, "total": 328, "total_pages": 17 }
}
最佳实践:对内容、媒体、日志、报告、任务和大型翻译队列使用分页。避免在一次调用中请求整个站点数据集。
对于内容更新、SEO 更改、翻译更新和页面布局修改,开发人员应使用预览-应用模式。这可以防止意外覆盖并保持人类的控制。
POST /wp-json/lemonx/v1/content/123/preview-update
API 返回建议的更改、之前/之后的差异以及预览参考。
POST /wp-json/lemonx/v1/content/123/apply-update
所应用的更新存储在活动日志中以供审查。
为什么它很重要:AI 生成的更改可能很有用,但生产网站需要审查、可追溯性和清晰的回滚路径。预览-应用工作流程可降低风险,同时保持强大的自动化功能。
开发人员可以使用 webhooks 在重要的 LemonX 操作发生时接收事件,而不是不断轮询 REST API。
目标:从一个仪表板监控多个 LemonX 支持的客户端站点。
GET /siteGET /site/healthGET /pro/licenseGET /aeo/overviewGET /verto/reportsGET /MCP/logsGET /reports/seo结果:您的代理团队可以在一处查看站点运行状况、SEO 状态、翻译进度、许可证状态和 AI 活动。
目标:从外部编辑系统创建 WordPress 草稿。
POST /content/draftsPOST /aeo/schema/generatePOST /aeo/internal-links/suggestPOST /content/{id}/preview-updatePOST /verto/queue结果:在 WordPress 之外创建的内容作为结构化草稿进入 LemonX,获得 SEO 就绪并可以排队等待翻译。
目标:发布或准备 WooCommerce 产品页面的翻译版本。
GET /verto/languagesPOST /verto/queueGET /tasks/{task_id}POST /verto/seo/generatePOST /verto/applyPOST /aeo/indexing/submit结果:产品页面已翻译,多语言 SEO 字段已生成,并且 URLs 可以准备用于索引。
目标:构建一个外部 UI,用户可以在其中生成 WordPress 登陆页面。
GET /code/templatesPOST /code/pages/generatePOST /code/sections/generatePOST /content/draftsPOST /content/{id}/preview-update结果:您的外部应用程序可以使用 LemonX Code 工作流程在 WordPress 内生成页面草稿。
目标:跟踪 AI 代理操作和敏感站点操作。
GET /MCP/logsGET /tasks/historyGET /reports/MCPGET /site/healthGET /pro/usage结果:网站所有者和机构可以查看 AI 活动、检测失败的任务并监控高影响力的工作流程。
在调用特定于产品的端点之前,请检查站点功能和活动产品。
不要将管理员级凭据用于仅需要读取访问权限或草稿创建的工作流程。
在应用内容、翻译、SEO 或布局更改之前使用预览端点。
AI 生成、翻译、OCR 和报告可能需要时间。使用任务 ID 和状态端点,而不是假设立即完成。
如果您的系统需要对事件做出反应,请使用 Webhook 而不是频繁轮询。
AI,翻译、索引和云连接操作可能受到计划限制和配额的约束。
将请求 ID、任务 ID 和操作引用存储在外部系统中。
大型工作流程可能会完成某些步骤而导致其他步骤失败。设计您的集成以安全地重试。
AI 生成的内容在直播发布之前应经过编辑、SEO 和品牌审核。
当 LemonX 发布 API 更改时,使用版本化端点并更新集成。
为多个客户站点构建仪表板、生成报告、监控活动并自动化可重复的内容工作流程。
将 LemonX 支持的 WordPress 网站连接到您的平台并触发内容、SEO、翻译或报告工作流程。
将 WordPress 内容操作与内部规划工具、编辑日历和报告仪表板连接起来。
构建自定义插件、管理屏幕、自动化脚本、迁移工具和外部应用程序。
将 REST API 工作流程与 MCP、webhooks 和 AI 提供程序管道相结合。
自动化产品内容、多语言产品页面、SEO 字段、架构和索引工作流程。
LemonX REST API 不会替换 WordPress REST API。它通过特定于产品的 AI、SEO、翻译、MCP 和增长工作流程扩展了开发人员的界面。
从内容工作流程到 SEO 自动化,从翻译队列到 MCP 日志,从许可到报告 – LemonX REST API 为开发人员提供了一种在 LemonX 生态系统之上进行构建的结构化方法。