开发者中心 是您将 Exayard 连接到自有代码和工具的地方。从 设置 然后 开发者 打开它。您可以在这里创建 API 密钥、注册 webhook 端点,并查看每个 API 请求的实时日志。只有组织管理员才能访问此页面。
API 密钥
API 密钥 用于对发往 Exayard API 的请求进行身份验证。密钥归属于您的组织,因此系统会自动选择正确的账户,无需传入组织 ID。
在 凭据 卡片中打开 API 密钥 选项卡并点击 + 按钮。为密钥指定一个 名称,然后选择其 权限范围。选择 全部 可授予所有权限范围,或选择 指定 以挑选单项权限。权限范围按资源遵循读写分离,例如 read:projects 和 write:estimates。admin:org 权限范围是完全访问授权。请选择您的集成所需的最小权限范围。
Exayard 仅在您创建密钥后立即完整显示该密钥一次。请当时复制,因为它再也不会显示。此后,每个密钥都会以其名称、形如 ak_••••1234 的掩码预览,以及最后一次使用日期一并显示。
使用铅笔图标可重命名密钥或更改其权限范围。使用垃圾桶图标可 吊销 密钥。吊销是永久性的,任何使用该密钥的集成都会立即停止工作。
同一密钥也用于对无代码集成进行身份验证。请参阅 将 Exayard 连接到 Zapier、将 Exayard 连接到 Make 和 将 Exayard 连接到 n8n。有关智能体和 AI 编辑器的访问,请参阅 连接到 Claude 和其他 AI 工具。
Webhook
webhook 让 Exayard 在发生某事时通知您的服务器。打开 Webhooks 选项卡并点击 + 即可添加一个端点。输入应接收投递的 URL 以及可选的 描述。
选择要订阅的 事件。选择 全部 可接收每个事件,或选择 指定 以从列表中挑选:
事件 | 触发时机 |
| 创建项目时 |
| 项目被更改时 |
| 项目被归档时 |
| 工程量评估开始时 |
| 评估完成时 |
| 评估被批准时 |
| 评估被取消时 |
| 生成估算时 |
| 生成投标时 |
| 上传的文件处理完成时 |
当您创建端点时,Exayard 会显示一个 签名密钥 一次。请当时复制,因为它不会再次显示。
保护 webhook 投递安全
每次投递都会携带一个形如 t=<unix>,v1=<digest> 的 Exayard-Signature 标头。Exayard 通过拼接时间戳和请求正文,然后使用您的端点密钥以 HMAC-SHA256 对其签名,从而构建签名。
要验证一次投递,请使用您的密钥重新计算签名,确认时间戳在当前时间的五分钟以内,然后比较摘要。投递失败会以指数退避方式在大约三天内重试。
要编辑端点,请点击铅笔图标。您可以更改 URL、描述和事件,并将其 状态 设置为 活动 或 已暂停。已暂停的端点会停止接收投递。同一对话框中有一个 轮换密钥 按钮。轮换会签发一个新密钥,旧密钥会立即停止工作,因此请在轮换前更新您的服务器。垃圾桶图标会删除端点并终止对它的所有投递。
快速入门
快速入门 卡片包含一段为 Claude 或 Cursor 等 AI 编辑器现成准备的提示词。点击 复制提示词 并将其粘贴到您的编辑器中。该提示词包含 API 基础 URL、身份验证格式、权限范围词汇表以及 webhook 签名方案,因此 AI 可以搭建一个可用的集成,并向您索取所需的详细信息。
文档
文档 卡片链接到完整的开发者文档以及 OpenAPI 规范,后者描述了每个路由和数据结构。连接 MCP 会打开将 AI 智能体直接连接到 Exayard 的设置。
日志
日志 区块记录您最近的 API 请求,涵盖 REST API 和 MCP。每一行都会显示方法、路径、响应状态和延迟。选择某一行即可查看其完整详情,包括请求 ID 以及请求和响应正文。使用日志可确认某次调用是否成功,或调试失败的集成。
