WebsiteCoach API
使用 WebsiteCoach API 获取缓存的网站报告 JSON 和优先行动项,用于内部仪表盘、客户门户和自动化流程。
Ludwig Makhyan · 创始人, WebsiteCoach
WebsiteCoach API 的用途
WebsiteCoach API 让注册用户以编程方式访问与应用内相同的报告数据。它适用于需要 JSON 格式网站健康数据的内部仪表盘、客户门户、报告流程和自动化工具。
公开文档有意避免暴露私有令牌、内部实现细节、仅管理员可用的路由或敏感抓取设置。用户可在登录后的个人资料区域生 成和管理自己的 API 令牌。
缓存报告 JSON
获取某个域名的最新已保存报告,包括评分、指标、部门和证据字段。
行动项端点
仅获取优先修复列表,包括优先级、部门、描述、指标、目标和置信度。
AI 修复提示词
获取可直接复制到 AI 编程工具的提示词,包含审计证据、URL、学习链接,以及供应商侧修复的手动说明。
关联历史的访问
API 报告查看会关联到已认证用户,因此相同域名会出现在账户历史和管理员历史中。
令 牌控制
用户可以为不同工具创建独立令牌,并撤销某个令牌,而无需暴露密码或会话。
公开 API 端点
完整缓存报告
当你的应用需要某个域名的完整已保存报告时使用。
GET https://websitecoach.com/api/reports?url=example.com&token=YOUR_TOKEN&lang=en仅行动项
用于创建工单、管理层仪表盘,或只需要优先修复列表的集成。
GET https://websitecoach.com/api/actionitems?url=example.com&token=YOUR_TOKEN&lang=enAI 修复 payload
当你的流程需要把 WebsiteCoach 发现的问题发送到 ChatGPT、Claude、Gemini、Cursor 或其他 AI 编程助手时使用。
GET https://websitecoach.com/api/payload?url=example.com&token=YOUR_TOKEN响应会返回每个行动项的部门、优先级、学习链接、审计证据和结构化提示词。提示词会要求 AI 先检查用户的技术栈;如果修复属于 DNS、CDN、邮箱、注册商、CMS 或其他外部控制台,则 提供详细的手动操作步骤,而不是臆造代码修改。
Bearer 令牌格式
服务端应用可以在 Authorization 请求头中发送令牌,而不是放在查询字符串中。
Authorization: Bearer YOUR_TOKEN令牌和数据安全
将令牌保留在服务器端
- 不要将 API 令牌放在公开 JavaScript、移动应用、截图或共享文档中。
- 为不同应用创建独立令牌,这样可撤销一个集成而不影响其他集成。
- 仅使用 HTTPS,并在团队成员、供应商或系统不再需要访问时轮换令牌。
- API 只返回认证令牌所有者可访问的报告数据;不会暴露密码、会话、账单密钥、管理员路由或私有抓取请求头。
访问与限制
API 访问面向注册用户开放。每位用户可在个人资料中创建最多 10 个有效 API 令牌。
API 调用用于缓存报告检索和行动项流程。新扫描和基于积分的刷新行为可能会变化,因此公开集成应依赖已记录的缓存报告和行动项端点。
要创建或撤销令牌,请登录并打开 API tokens.
需要私有集成?
对于合作伙伴或企业用例,在依赖非公开行为之前请联系 WebsiteCoach。公开文档是稳定契约。
相关主题