將 Clipping Magic 智慧編輯器整合入您的自設工作流程的最便捷的方式。
請務必首先閲讀快速啟動。
使用伺服器 API 上傳一個圖像。
建立一個托管智慧編輯器 URL,並將其提供給裁剪您指定的圖像的真人操作者。
裁剪所有圖像後,您的真人操作者的瀏覽器將巡覽至指定的傳回 URL,並顯示一個包含裁剪工作階段相關資訊的 HTTP POST。
如果您需要一個白標解決方案或每個已裁剪圖像的回呼,請參閱白標智慧編輯器。
https://clippingmagic.com/api/v1/hosted/[apiId]
您可以建立一個簡單的 URL,供您的真人操作者在其瀏覽器中開啟,以審閲並編輯您的一個或多個圖像。
托管智慧編輯器 URL 支援以下參數:
images
id1:secret1,id2:secret2,... 123:abc,456:def
必要項 |
供剪裁的圖像。 以逗號分隔的 |
||||||||||||||||||||||||||||||||||||
returnUrl
字串 必要項 |
您的真人操作者完成了剪裁後,其瀏覽器會發出 HTTP POST 至此 URL。 請參閲下方細節。 |
||||||||||||||||||||||||||||||||||||
useStickySettings
布林值 true 、false
|
若您傳入 如此您就可以自設基本剪裁設定一次,然後將其套用到您編輯的所有圖像。 Read about how to configure the sticky settings 預裁剪在 API 中無法使用,但您可以在 API 的上傳呼叫中設定圖像大小限制。
預設: |
||||||||||||||||||||||||||||||||||||
hideBottomToolbar
布林值 true 、false
|
隱藏底部工具列,從而使這些設定在編輯器中無法使用。
預設: |
||||||||||||||||||||||||||||||||||||
locale
字串 |
編輯器使用的顯示語言。若省略,預設為英文。有效值為:
|
新式瀏覽器允許很長的 URL,但若您需要支援舊版瀏覽器並在一個工作階段中剪裁超過 30 個圖像,則可以透過 POST 而非直接連結進行提交。
單圖像 URL 範例
https://clippingmagic.com/api/v1/hosted/123?images=2346:image_secret1&returnUrl=https%3A%2F%2Fclippingmagic.com%2Fapi%2FreturnUrlExample
指定單個圖像時,編輯器沒有「跳過」按鈕,並且不會顯示剩餘的待剪裁圖像數。
多圖像 URL 範例
https://clippingmagic.com/api/v1/hosted/123?images=2346:image_secret1,2347:image_secret2&returnUrl=https%3A%2F%2Fclippingmagic.com%2Fapi%2FreturnUrlExample
指定多個圖像時,編輯器有「跳過」按鈕,並且顯示剩餘的待剪裁圖像數。
您的真人操作者完成剪裁後,其瀏覽器會發出 HTTP POST 至您指定的傳回 URL。 該 POST 會包含一個單一參數:clippingMagicJson
。 當您解析該參數的内容時,其會拆包至一個包含哪些圖像已剪裁的資訊的 JSON 物件。 您即可透過使用,下載現在可用的結果。
event
列舉 editor-exit 、error
|
|
||||||
images
[{"id":1,"secret":"secret1"},{"id":2,"secret":"secret2"},{"id":3,"secret":"secret3"},{"id":4,"secret":"secret4"}] |
含托管智慧編輯器 URL 中所提供圖像的陣列。 | ||||||
clipped
[{"id":1,"secret":"secret1"},{"id":2,"secret":"secret2"}] |
含此工作階段中實際剪裁圖像的陣列,即真人操作者在編輯器中按下了「完成」的圖像。 | ||||||
skipped
[{"id":3,"secret":"secret3"},{"id":4,"secret":"secret4"}] |
含此工作階段中跳過的圖像的陣列,即真人操作者在編輯器中按下了「跳過」的圖像。 | ||||||
若
|
您將需要停用所有 CSRF 檢查,或者將 CSRF 權杖添加至傳回 URL,POST 方可成功。
若您的真人操作者關閉其瀏覽器,或者您使用一個不可解析的托管智慧編輯器 URL,則您的傳回 URL 不會被呼叫。
clippingMagicJson
解碼至:
{ "event" : "editor-exit", "images" : [ { "id" : 2346, "secret" : "image_secret1" }, { "id" : 2347, "secret" : "image_secret2" } ], "clipped" : [ { "id" : 2346, "secret" : "image_secret1" }, { "id" : 2347, "secret" : "image_secret2" } ], "skipped" : [ ] }
clippingMagicJson
解碼至:
{ "event" : "error", "error" : { "status" : 400, "code" : 1234, "message" : "Example error" }, "images" : [ { "id" : 2346, "secret" : "image_secret1" }, { "id" : 2347, "secret" : "image_secret2" } ], "clipped" : [ ], "skipped" : [ { "id" : 2346, "secret" : "image_secret1" }, { "id" : 2347, "secret" : "image_secret2" } ] }