ホステッドスマートエディター

Clipping Magic スマートエディターをお客様のカスタムワークフローに統合する簡単な方法です。

統合手順

まず、クイックスタートをお読みください。

  1. サーバー API を使用して画像をアップロードします。

  2. 人間のオペレーターが指定された画像をクリップする場である ホステッドスマートエディター URL を作成し、オペレーターにそれを指し示します。

  3. すべての画像のトリミングを終えた後、オペレーターのブラウザーは、トリミングセッションについて関連情報が含まれる HTTP POST と共に指定されたリターン URL に移行します。

ホワイトラベルソリューションまたはトリミングした画像についてコールバックが必要な場合は、ホワイトラベルスマートエディターを参照してください。

ホステッドスマートエディター URL https://clippingmagic.com/api/v1/hosted/[apiId]

シンプル URL を作成して、人間のオペレーターがそれをブラウザーで開き、1 つまたはそれ以上の画像を検証できるようにします。

ホステッドスマートエディター URL は、以下のパラメーターに対応しています。

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

クリップ対象の画像。 カンマで区切られた、id:secret ペアのリスト。 サーバー API を使用して画像をアップロードすることにより、これらを取得できます。

returnUrl
文字列
必須

人間のオペレーターがクリップを終了すると、ブラウザーはこの URL に HTTP POST を発行します。 詳細は以下を参照してください。

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 に対応していますが、レガシーブラウザーにも対応する場合、および 1 つのセッションで 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

人間のオペレーターがクリップを終了すると、ブラウザーは、指定されたリターン URL に HTTP POST を発行します。 その POST には、その本体に単一のパラメータ、clippingMagicJson が含まれます。 そのパラメータのコンテンツをパースすると、そのコンテンツは、クリップされた画像に関する情報を含む JSON オブジェクトに解凍されます。 次に、サーバー API をダウンロードを使って利用可能になった結果をダウンロードできます。

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
文字列
発生したエラーを説明する、人間が読みやすいエラーメッセージ。

POST を正しく実施するためには、CSRF チェックを無効にするか、リターン URL に CSRF トークンを追加しなければなりません。

人間のオペレーターがブラウザーを閉じるか、パースのできないホステッドスマートエディター 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 をテストする