将 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" } ] }