OpsIQ API是否支持幂等性?
是的,开发者模型包括幂等重放保护用于写入。此功能包括一个文档化的24小时幂等性窗口用于支持的操作。客户在网络故障后重试相同的预期写入时应重用相同的密钥。对于真正的新操作,应创建一个新密钥。 相关文章 开发者 API, Webhooks & 连接器构建器 — OpsIQ OpsIQ 文档与开发者文档 — OpsIQ Portal Studio 管理员和开发者指南 — OpsIQ 我如何对OpsIQ通用API进行身份验证? 通过…
通过OpsIQ通用API可用多少个操作?
当前开发者和集成页面描述了1,558个命名的通用API操作,由62个最小权限范围管理。操作注册表确保API行为、操作文档、范围和验证保持一致。集成应仅调用它们实际需要的操作。 相关文章 开发者 API, Webhooks & 连接器构建器 — OpsIQ OpsIQ 文档与开发者文档 — OpsIQ Portal Studio 管理员和开发者指南 — OpsIQ 我如何对OpsIQ通用API进行身份验证? OpsIQ API…
OpsIQ 提供什么 SDK 和 API 参考格式?
OpsIQ 提供一个 OpenAPI 3.0.3 描述,Postman 资源,以及用于 PHP、Node.js 和 Python 的辅助模式。这使得团队能够与他们首选的技术栈集成,而不是依赖于单一的专有 SDK。然而,审查生成的客户端在处理秘密、超时、重试和幂等性等方面是很重要的。 相关文章 API 限流在 OpsIQ 中是如何工作的? 自定义结账如何将转化发送到 OpsIQ?
OpsIQ 的出站网络钩子是如何签名的?
OpsIQ 使用 HMAC-SHA256 对原始请求体签名出站网络钩子负载。它还包括交付元数据,如时间戳和事件。接收方应遵循以下步骤: 从确切的原始主体计算签名。 以恒定时间比较计算出的签名。 验证时间戳。 以幂等方式处理重复交付。 相关文章 签名的 Webhooks 和 API 操作用于自动化 — OpsIQ 集成、API 和连接器构建器 — OpsIQ OpsIQ 能否与我们已经使用的工具连接? OpsIQ…
我如何创建一个 OpsIQ 客户 API 令牌?
要创建一个 OpsIQ 客户 API 令牌,请按照以下步骤操作: 打开 API 令牌部分。 创建一个具有描述性名称的令牌。 选择适当的可用权限。 令牌创建后,请立即复制密钥并安全存储。完整密钥仅显示一次。OpsIQ 保留受保护的表示以供验证,并且不会再次显示原始密钥。 相关文章 OpsIQ 的出站 Webhook 是如何签名的? 我如何对OpsIQ通用API进行身份验证? 通过 OpsIQ 通用 API 可用多少操作? OpsIQ…
我如何认证到 OpsIQ 通用 API?
认证到 OpsIQ 通用 API OpsIQ 的通用 API 使用范围 Bearer API 密钥。重要的是,这些密钥仅分配必要的最低权限范围。此外,它们必须安全地存储为秘密,并且不应包含在公共浏览器代码或代码库中。 开发者网站提供详细信息: 62 个可用范围 一个常见的 API 入口点 速率限制头 稳定的操作合同 相关文章 开发者 API, Webhooks & 连接器构建器 — OpsIQ OpsIQ 文档与开发者文档 —…
我可以在不删除的情况下暂时禁用一个 API 令牌吗?
是的,API Tokens 支持禁用和稍后重新启用一个令牌。当一个集成应该暂时停止使用它时,您可以禁用该令牌。请记住,在该令牌被禁用时,连接的集成将无法通过身份验证。 相关文章 OpsIQ 的出站 Webhook 是如何签名的? 我如何对OpsIQ通用API进行身份验证? 通过 OpsIQ 通用 API 可用多少操作? OpsIQ API 是否支持干运行请求? OpsIQ API 是否支持幂等性? OpsIQ 提供哪些 SDK 和…
API 速率限制在 OpsIQ 中是如何工作的?
OpsIQ 针对每个密钥应用 API 速率限制,并在响应头中返回速率限制信息。当超过限制时,客户端会收到 HTTP 429 状态码,并附带有关何时通过 Retry-After 头重试的指导。 集成应实施退避策略,而不是立即重试。重要的是要记住,计划限制分别适用于密钥、操作、网络钩子、集成和触发器。 相关文章 OpsIQ 提供哪些 SDK 和 API 参考格式? 自定义结账如何将转化发送到 OpsIQ?
OpsIQ 中的客户 API 令牌是什么?
客户 API 令牌允许您在不共享账户密码的情况下授权支持的客户范围集成。这些令牌可以根据创建令牌时提供的范围,携带对支持的账户、许可证、计费或支持操作的有限权限。重要的是只给予集成其实际需要的权限。 相关文章 OpsIQ 的出站 Webhook 是如何签名的? 我如何对OpsIQ通用API进行身份验证? 通过 OpsIQ 通用 API 可用多少操作? OpsIQ API 是否支持干运行请求? OpsIQ API 是否支持幂等性?…
为什么我无法再次看到我的 API 令牌密钥?
令牌密钥在创建时仅会显示一次。账户存储所需的信息以验证未来的令牌使用,而不是为了后续显示而存储可重复使用的明文副本。如果您丢失了密钥,您需要创建一个替代令牌并禁用或删除丢失的那个。 相关文章 OpsIQ 的出站 Webhook 是如何签名的? 我如何对OpsIQ通用API进行身份验证? 通过 OpsIQ 通用 API 可用多少操作? OpsIQ API 是否支持干运行请求? OpsIQ API 是否支持幂等性? OpsIQ 提供哪些…
我可以看到关于API令牌的哪些信息?
API Tokens 页面提供有关每个令牌的各种详细信息,包括: 令牌名称 公共标识符 授予的权限 当前状态 使用信息(例如,最后一次使用的时间) 请注意,创建后不会重新显示密钥本身。 相关文章 OpsIQ 的出站 Webhook 是如何签名的? 我如何对OpsIQ通用API进行身份验证? 通过 OpsIQ 通用 API 可用多少操作? OpsIQ API 是否支持干运行请求? OpsIQ API 是否支持幂等性? OpsIQ…
OpsIQ API 是否支持干运行请求?
是的,OpsIQ API 支持干运行请求。支持的操作可以利用 dry_run 行为,允许集成者在不提交写入的情况下验证意图和参数。此功能对于高影响力的自动化和测试特别有用。然而,重要的是要注意,干运行并不能替代暂存,因为并非每个外部副作用都可以安全地重现。 相关文章 开发者 API, Webhooks & 连接器构建器 — OpsIQ OpsIQ 文档与开发者文档 — OpsIQ Portal Studio 管理员和开发者指南 —…
当我删除一个 API 令牌时会发生什么?
删除令牌会永久性地将该客户令牌从活动使用中移除。任何仍然配置了它的集成将停止认证,如果仍然需要访问,必须使用新令牌进行更新。如果您想要可逆的暂停而不是永久删除,请先禁用该令牌。 相关文章 OpsIQ 的出站 Webhook 是如何签名的? 我如何对OpsIQ通用API进行身份验证? 通过 OpsIQ 通用 API 可用多少操作? OpsIQ API 是否支持干运行请求? OpsIQ API 是否支持幂等性? OpsIQ 提供哪些…
我可以使用一个 OpsIQ API token 来代替我的账户密码进行集成吗?
是的,您可以使用一个 OpsIQ API token 来代替您的账户密码进行支持的客户 API 操作。此方法比提供与您的交互账户密码的集成更可取,因为该 token 可以独立命名、作用域、监控、禁用和替换。保持 token 的秘密并避免将其包含在浏览器 URL、工单和日志中是很重要的。 相关文章 OpsIQ 的出站 Webhook 是如何签名的? 我如何对OpsIQ通用API进行身份验证? 通过 OpsIQ 通用 API…