Clipping Magic は、画像のアップロードおよび結果のダウンロードを自動化するために、REST 指向のウェブ API を提供します。 ClippingMagic.js で Clipping Magic エディターをお客様のウェブサイトに統合し、ユーザーが背景の削除をお客様のウェブサイトで行うことができるようにします。
API は、ユーザーが提供した画像から背景を削除する必要があるウェブサイトや、一連の画像の背景を削除するグラフィックデザイナーを擁する E コマースウェブサイトで特に便利です。
API を使用するには、API キーと若干のウェブプログラミング技術が必要です。
代表的な状況は、エンドユーザーに画像をお客様のサイトにアップロードして貰い、お客様のサイト画像ワークフローの一環として、ユーザーにその画像から背景を削除する機能を提供することです。 通常取り得るステップは以下となります。
画像を バックエンド API 経由で ClippingMagic.com へアップロード。画像 id とシークレットを取得。
お客様のサイトで、エンドユーザーが ClippingMagic.js により、1 枚の画像の編集 ワークフローおよびステップ 1 からの画像 id およびシークレットを使ってで背景を削除することができるようにする。
result-generated コールバックを ClippingMagic.js から受信したら、その画像の結果をダウンロードするようバックエンドに通知する。
結果をダウンロードし、サイト固有のワークフローにしたがってその次のステップを続ける。
代表的な状況は、処理すべき多くの画像があり、スタッフがそれらを処理することです。通常取り得るステップは以下となります。
バックエンド API 経由で、画像のバッチを 1 枚ずつアップロードする。 それぞれの画像 id とシークレットを取得して保存する。
お客様の内部システムで、画像を適切なバッチでスタッフに割り当てる。 各スタッフが ClippingMagic.js により、複数の画像を連続的に編集 ワークフローおよびステップ 1 からのそれぞれに対応する画像 id とシークレットを使ってバッチの背景削除作業を行う。
代表的なバッチサイズは、10 から 100 まで、画像の量と特徴によって、異なります。
result-generated を ClippingMagic.js から受信したら、バックエンドにその画像の結果をダウンロードするように通知する。
上記を繰り返す。
すべてのアップロードおよびダウンロード作業はバックエンドで行われますが、すべてのクリップ作業は ClippingMagic.js を使ってウェブクライアント（フロントエンド）で行われることに注意してください。
この分割は、API キーを保護すると共に、お客様のサイトにおけるシームレスなエンドユーザーエクスペリエンスを可能にします。