API Trigger

以 HTTP API 觸發指定的自動化技能,與所有觸發共用序列,排序執行。

開啟 API 觸發

開啟 API 觸發後 EMILY 會啟動 API server,端點連結顯示在開關之後,uuid 參數即為欲執行的自動化技能識別碼,例如:GET http://ip-address:port/api?uuid=1a2b 表示為請求 EMILY 執行識別碼為 1a2b 的自動化技能;若希望上傳自動化技能需要的檔案作為輸入,可以採用 POST http://ip-address:port/api?uuid=1a2b 並將輸入檔案以 multipart/form-data 上傳,下圖以 HTTP 工具 Postman 為例:

加入 API

點擊任一技能後彈出選單中,選擇 加入 API 即可將這個技能開放給其它於同個網段的裝置以 API 請求 EMILY 執行。

詢問工作狀態

想要取得 EMILY 的整體工作狀態可以使用 GET /api 無須帶任何參數,工作狀態會包含:是否正在執行 executing / 等待序列長度 waiting / 已完成工作數量 finished:

當使用 API 觸發一個技能後會返回一個 JSON 物件 { msUnixTime: "1656215466302" },代表已經將指定技能排入工作序列, caller 端可以利用 GET /api/job?uuid=1a2b&msUnixTime=1234 來得到這個工作的目前狀態,狀態包括 inqueue / executing / finished:

Last updated