跳转到主要内容
Gorelo 允许你通过 Gorelo API 与任何外部产品集成。 Gorelo API 使用 API 密钥。在每次请求中通过 X-API-Key 标头包含你的密钥。 Gorelo 的基础 URL 取决于你选择在 Gorelo 中托管数据的区域:
API 参考中的端点页面默认使用美国基础 URL。如果你的数据托管在澳大利亚,请点击端点页面顶部的基础 URL,然后选择 https://api.aue.gorelo.io。
端点页面上的基础 URL 菜单,已选择 https://api.aue.gorelo.io

示例请求

以下 JavaScript fetch 代码片段展示了如何使用 X-API-Key 标头进行身份验证。将 YOUR_API_KEY 替换为你的密钥,并将基础 URL 替换为托管你数据的区域对应的 URL。
GET
POST

作用域和权限

API 密钥可以限定作用域。如果某个密钥对某端点没有访问权限,API 会返回 403 Forbidden。 Documents 作用域允许密钥访问文档。

自定义字段

API 响应中的自定义字段包含 IsSet 和 IsHidden。要避免某个自定义字段的值出现在 API 中,请为该字段开启 Hide Value from API。

导入历史记录

当你导入 CreatedOn 为过去日期的记录时,Gorelo 不会发送任何通知,也不会触发任何自动化。
对于使用 CreatedOn 导入的时间条目,Gorelo 会将其保存为 Completed 状态,因此不会被开具发票。之后你无法通过 API 更改或删除这些时间条目。

错误处理

状态 ID

代理资产

字段和值说明

警报

警报通过 AgentAssetId、CustomAssetId 或 UptimeId 标识其关联的资产。使用相同的字段来筛选警报。
DeviceId 和 UptimeCheckId 是 AgentAssetId 和 UptimeId 的已弃用别名。请更新你的集成以使用当前的字段名称。

合同和发票

  • 合同字段: 合同响应会返回 DaysUntilDue、明细行上的 UnitCost,以及服务行上的 AutoApproveTime。
  • 合同行价格: 合同行上的 UnitPrice 返回实际收取的价格,而不是目录价格。
  • 可计费行: POST /v1/invoices 会将 No charge 和 Non-billable 行按 0 计费。对于需要收费的行,请发送 BillableStatusId 1。
  • 税费: 没有 TaxId 的发票行和合同行会采用应用中会应用的税费。若不收取税费,请发送你的免税税率 ID。
  • 删除合同: DELETE /v1/contracts/{contractId} 会像应用中一样停用合同,因此你可以恢复它。如果要改为归档合同,请发送 PATCH 并将 StatusId 设为 3。

文档关联项类型

文档上的关联项类型 4 为 Agent asset。按类型 ID 匹配的集成可继续正常工作。按类型名称匹配的集成必须使用 Agent asset。