- US
- Australia
Base URL:https://api.usw.gorelo.io/
API 參考文件:https://api.usw.gorelo.io/swagger
API 參考文件:https://api.usw.gorelo.io/swagger
API 參考中的端點頁面預設使用美國基礎 URL。如果你的資料託管在澳洲,請點擊端點頁面頂端的基礎 URL,然後選擇
https://api.aue.gorelo.io。
請求範例
以下 JavaScriptfetch 範例示範如何透過 X-API-Key 標頭進行驗證。請將 YOUR_API_KEY 替換為你的金鑰,並將 base URL 換成託管你資料的區域。
GET
POST
範圍與權限
API 金鑰可以被範圍化(scoped)。若某個金鑰缺乏對某個端點的存取權,API 會回傳 403 Forbidden。 Documents 範圍可讓金鑰存取文件。自訂欄位
API 回應中的自訂欄位包含IsSet 與 IsHidden。若不想讓自訂欄位的值出現在 API 中,請為該欄位開啟 Hide Value from API。
匯入歷史資料
當你匯入具有回溯
CreatedOn 的記錄時,Gorelo 不會傳送任何通知,也不會觸發任何自動化。CreatedOn 匯入的時間記錄儲存為 Completed,因此不會被開立發票。之後你無法透過 API 變更或刪除這些記錄。
錯誤處理
狀態 ID
Agent assets
欄位與值說明
警示
警示透過AgentAssetId、CustomAssetId 或 UptimeId 識別其相關的資產。使用相同的欄位來篩選警示。
合約與發票
- 合約欄位: 合約回應會傳回
DaysUntilDue、明細項目上的UnitCost,以及服務明細上的AutoApproveTime。 - 合約明細價格: 合約明細上的
UnitPrice會傳回實際收取的價格,而非目錄價格。 - 計費明細:
POST /v1/invoices會將 No charge 與 Non-billable 明細以 0 計費。對於應收費的明細,請傳送BillableStatusId1。 - 稅金: 未指定
TaxId的發票與合約明細,會套用應用程式原本會套用的稅金。若要不計稅,請傳送你的免稅稅率 ID。 - 刪除合約:
DELETE /v1/contracts/{contractId}會停用合約(與應用程式中的行為相同),因此你可以將其復原。若要改為封存合約,請傳送PATCH並將StatusId設為3。
文件相關項目類型
文件上的相關項目類型4 為 Agent asset。依類型 ID 比對的整合可繼續正常運作。依類型名稱比對的整合必須使用 Agent asset。