托管智能编辑器

将 Clipping Magic 智能编辑器整合进您的自定义工作流的最便捷的方法。

整合步骤

请务必先阅读快速启动

  1. 使用服务器 API 上载图像。

  2. 创建一个托管智能编辑器 URL,并将其提供给剪切您所指定的图像的真人操作者。

  3. 剪切所有图像后,您的真人操作者的浏览器将导航至指定的返回 URL,并显示一个包含该剪切会话相关信息的 HTTP POST。

如果您需要白标解决方案或者针对每幅剪切图像的回拨,请查看白标智能编辑器

托管智能编辑器 URL https://clippingmagic.com/api/v1/hosted/[apiId]

您可以创建一个简单的 URL,供您的真人操作者在其浏览器中打开,以审阅和编辑您的一幅或多幅图像。

托管智能编辑器 URL 支持以下参数:

images
id1:secret1,id2:secret2,...
123:abc,456:def
必需

供剪切的图像。 用逗号分隔的 id:secret对列表。 适用于您使用服务器 API上载图像的情况。

returnUrl
字符串
必需

您的真人操作者完成了剪切后,其浏览器会发出 HTTP POST 至此 URL。 参见下方细节。

useStickySettings
布尔
truefalse

如果您传入 useStickySettings=true,编辑器将使用其 API 密钥用于上载图像的用户当前配置的易贴设置。

这样您就可以对基本剪切设置进行一次配置,然后将其应用于您编辑的所有图像。

Read about how to configure the sticky settings

预剪裁在 API 中不可用,但您可以在 API 上载呼叫中配置图像尺寸限制。

locale
字符串

编辑器使用的显示语言。如果缺失,默认值为英文。有效值为:

代码显示语言
en-US English (英语)
de-DE Deutsch (德语)
es-ES Español (西班牙语)
fr-FR Français (法语)
hi-IN हिन्दी (印地语)
id-ID Indonesia (印度尼西亚语)
it-IT Italiano (意大利语)
ja-JP 日本語 (日语)
ko-KR 한국어 (韩语)
pl-PL Polski (波兰语)
pt-BR Português (葡萄牙语)
ru-RU Русский (俄语)
th-TH ไทย (泰语)
tr-TR Türkçe (土耳其语)
vi-VN Tiếng Việt (越南语)
zh-Hans-CN 简体中文 (中文)
zh-Hant-TW 繁體中文 (中文)

现代浏览器接收非常长的 URL,但如果您需要支持传统浏览器并在一次会话中剪切超过 30 幅图像,可以通过 POST 而非直接链接进行提交。

单图像 URL 示例


https://clippingmagic.com/api/v1/hosted/123?images=2345:image_secret&returnUrl=https%3A%2F%2Fclippingmagic.com%2Fapi%2FreturnUrlExample

指定单幅图像时,编辑器没有“跳过”按钮,并且不会显示剩余的待剪切图象数量。

多图像 URL 示例


https://clippingmagic.com/api/v1/hosted/123?images=2345:image_secret,2346:image_secret2&returnUrl=https%3A%2F%2Fclippingmagic.com%2Fapi%2FreturnUrlExample

指定多幅图像时,编辑器有“跳过”按钮,并且显示剩余的待剪切图象数量。

返回 URL

您的真人操作者完成剪切时,其浏览器会发出 HTTP POST 至您指定的返回 URL。 该 POST 会包含一个单一参数:clippingMagicJson。 在您解析该参数的内容时,其会拆包至一个包含哪些图像被剪切的信息的 JSON 对象。 您即可通过使用,下载现在可用的结果。

event
枚举
editor-exiterror

editor-exit表示剪切会话成功结束。

error表示出现错误,并且下方的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"}]
包含在本次会话中跳过的图像的阵列,即真人操作者在编辑器中点击了“跳过”的图像。

如果event=error,则将有使用以下填充的error成员对象:

error.status
整数
类似 HTTP 状态的代码。 4xx表示一个调用方错误。 5xx表示一个内部服务器错误。
error.code
整数
唯一识别发生的错误的数字。
error.message
字符串
描述发生的错误的人类可读错误消息。

您将需要禁用所有 CSRF 检查,或者将 CSRF 令牌添加至返回 URL,POST 方可成功。

如果您的真人操作者关闭其浏览器,或者您使用一个不可解析的托管智能编辑器 URL,则您的返回 URL 不会被调用。

成功示例 clippingMagicJson解码至:
{
  "event" : "editor-exit",
  "images" : [ {
    "id" : 2345,
    "secret" : "image_secret"
  }, {
    "id" : 2346,
    "secret" : "image_secret2"
  } ],
  "clipped" : [ {
    "id" : 2345,
    "secret" : "image_secret"
  }, {
    "id" : 2346,
    "secret" : "image_secret2"
  } ],
  "skipped" : [ ]
}
测试您的返回 URL
错误示例 clippingMagicJson解码至:
{
  "event" : "error",
  "error" : {
    "status" : 400,
    "code" : 1234,
    "message" : "Example error"
  },
  "images" : [ {
    "id" : 2345,
    "secret" : "image_secret"
  }, {
    "id" : 2346,
    "secret" : "image_secret2"
  } ],
  "clipped" : [ ],
  "skipped" : [ {
    "id" : 2345,
    "secret" : "image_secret"
  }, {
    "id" : 2346,
    "secret" : "image_secret2"
  } ]
}
测试您的返回 URL