Clipping Magic スマートエディターをお客様のカスタムワークフローに統合する簡単な方法です。
まず、クイックスタートをお読みください。
サーバー API を使用して画像をアップロードします。
人間のオペレーターが指定された画像をクリップする場である ホステッドスマートエディター URL を作成し、オペレーターにそれを指し示します。
すべての画像のトリミングを終えた後、オペレーターのブラウザーは、トリミングセッションについて関連情報が含まれる HTTP POST と共に指定されたリターン URL に移行します。
ホワイトラベルソリューションまたはトリミングした画像についてコールバックが必要な場合は、ホワイトラベルスマートエディターを参照してください。
https://clippingmagic.com/api/v1/hosted/[apiId]
シンプル URL を作成して、人間のオペレーターがそれをブラウザーで開き、1 つまたはそれ以上の画像を検証できるようにします。
ホステッドスマートエディター URL は、以下のパラメーターに対応しています。
|
images
id1:secret1,id2:secret2,... 123:abc,456:def
必須 |
クリップ対象の画像。 カンマで区切られた、 |
||||||||||||||||||||||||||||||||||||
|
returnUrl
文字列 必須 |
人間のオペレーターがクリップを終了すると、ブラウザーはこの URL に HTTP POST を発行します。 詳細は以下を参照してください。 |
||||||||||||||||||||||||||||||||||||
|
useStickySettings
ブーリアン true、false
|
これにより、基本クリッピング設定が設定され、編集するすべての画像にわたり適用されます。 Read about how to configure the sticky settings プリクロップは API では利用できませんが、画像サイズ制限は API アップロードコールで設定できます。
デフォルト： |
||||||||||||||||||||||||||||||||||||
|
hideBottomToolbar
ブーリアン true、false
|
下部のツールバーが非表示となり、それらの設定がエディターで使用できなくなります。
デフォルト： |
||||||||||||||||||||||||||||||||||||
|
locale
文字列 |
エディターで使用する表示言語。省略された場合は、デフォルトで英語になります。有効な値は以下です。
|
最新のブラウザーは、非常に長い URL に対応していますが、レガシーブラウザーにも対応する場合、および 1 つのセッションで 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
複数画像を指定する場合、エディターは「スキップ」ボタンや残りのクリップ対象画像数を表示します。
人間のオペレーターがクリップを終了すると、ブラウザーは、指定されたリターン URL に HTTP POST を発行します。 その POST には、その本体に単一のパラメータ、clippingMagicJson が含まれます。 そのパラメータのコンテンツをパースすると、そのコンテンツは、クリップされた画像に関する情報を含む JSON オブジェクトに解凍されます。 次に、サーバー API をダウンロードを使って利用可能になった結果をダウンロードできます。
|
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"}] |
このセッションでスキップされた画像、すなわち、人間のオペレーターがエディターで「スキップ」をクリックした画像の配列。 | ||||||
|
|
|||||||
POST を正しく実施するためには、CSRF チェックを無効にするか、リターン URL に CSRF トークンを追加しなければなりません。
人間のオペレーターがブラウザーを閉じるか、パースのできないホステッドスマートエディター 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"
} ]
}