开发者 API, Webhooks & 连接器构建器 — OpsIQ

开发者 API, Webhooks & 连接器构建器 — OpsIQ

OpsIQ 提供一个强大的平台，通过其开发者 API、Webhooks 和连接器构建器构建受管集成。这使开发者能够创建以安全性和可靠性为重点的 AI 可操作应用程序。

关键特性

• 范围承载密钥: 生成具有最小权限访问的 API 密钥，以确保集成仅具有所需的权限。
• 合同生成的操作: 通过单一 API 访问 1,558 个命名操作，具有内置验证和重放安全写入。
• HMAC Webhooks: 订阅具有加密证明的事件，确保安全和可追溯的事件交付。
• OpenAPI 和 Postman 支持: 利用机器可读的 API 合同进行简单的集成和测试。

集成过程

1. 获取密钥: 注册并生成一个范围承载 API 密钥。
2. 发现与验证: 使用 API 读取可用操作，并使用干运行功能验证写入。
3. 执行与订阅: 使用幂等性密钥执行操作并订阅必要的事件。

事件处理

OpsIQ 允许开发者从其平台发出规范事件，多个组件如 AI 大脑和自动化规则可以订阅这些事件。事件以确定性顺序调度，确保关键操作优先处理。

操作合同

每个操作都受合同管理，合同指定其范围、风险和确认政策。这确保 AI 只能提出已注册的操作，从而保持对可执行内容的控制。

Webhook 安全

OpsIQ 使用 HMAC-SHA256 对 webhook 有效载荷进行签名，允许开发者验证传入事件的真实性。这包括可追溯的交付 ID 和对失败交付的自动重试。

SDK 和客户端生成

开发者可以使用直接 HTTP 调用或在多种编程语言中生成客户端，包括 PHP、Node.js 和 Python。完整的 API 在 OpenAPI 3.0.3 中有文档，并作为 Postman 集合提供。

连接器构建器

连接器构建器允许开发者通过六个阶段的过程创建受管包，确保在发布之前执行所有必要的验证和检查。这包括定义身份、认证、操作、触发器和审查阶段。

与 DIY 集成的比较

OpsIQ 提供一个全面的解决方案，包括干运行写入、操作合同注册和确认政策等功能，这些在 DIY 集成中通常难以实现。该平台的结构化方法确保了可靠性和安全性，使其成为开发者的优选。

常见问题

• 认证: API 调用需要承载令牌，webhooks 包含特定的头用于验证。
• AI 操作批准: AI 只能提出在操作注册中预先批准的操作。
• Webhook 验证: 开发者可以通过重新计算 HMAC 签名并与提供的签名进行比较来验证 webhooks。

有关更多信息，开发者可以访问文档并立即开始使用 OpsIQ 构建集成。