Editor Cerdas yang Dihosting

Cara termudah untuk mengintegrasikan Editor Cerdas Clipping Magic ke dalam alur kerja kustom Anda.

Langkah-langkah Integrasi

Pastikan untuk membaca Mulai Cepat terlebih dahulu.

  1. Unggah gambar menggunakan API Server.

  2. Buat URL Editor Cerdas yang Dihosting dan rujuk operator manusia Anda ke tempat tersebut, tempat mereka memotong gambar yang Anda tentukan.

  3. Setelah memotong semua gambar, operator browser manusia Anda menavigasi ke Return URL yang ditentukan dengan HTTP POST yang berisi informasi yang relevan tentang sesi pemotongan.

Jika Anda membutuhkan solusi label putih atau panggilan balik untuk setiap gambar yang dipangkas, lihat Editor Cerdas Label Putih.

URL Editor Cerdas yang Dihosting https://clippingmagic.com/api/v1/hosted/[apiId]

Anda dapat membuat URL sederhana dan meminta operator manusia Anda membukanya di browser mereka untuk meminta mereka meninjau dan mengedit gambar Anda.

URL Editor Cerdas yang Dihosting mendukung parameter berikut:

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

Gambar untuk dipotong. Daftar pasangan id:secret yang dipisahkan koma. Anda mendapatkannya dengan mengunggah gambar menggunakan API Server.

returnUrl
String
Diperlukan

Ketika operator manusia Anda selesai memotong, browser mereka akan mengeluarkan HTTP POST ke URL ini. Lihat perinciannya di bawah ini.

useStickySettings
Boolean
true, false

Jika Anda meneruskan useStickySettings=true editor akan menggunakan setelan lekat yang saat ini dikonfigurasi untuk pengguna yang kunci API-nya digunakan untuk mengunggah gambar.

Ini memungkinkan Anda mengonfigurasi pengaturan pemotongan dasar sekali, dan kemudian menerapkannya di semua gambar yang Anda edit.

Read about how to configure the sticky settings

Pra-Pangkas tidak tersedia melalui API, tetapi Anda dapat membuat konfigurasi Batas Ukuran Gambar dalam panggilan unggah API.

locale
String

Bahasa tampilan yang digunakan untuk editor. Defaultnya adalah bahasa Inggris jika dihilangkan. Nilai yang sah adalah:

KodeTampilan Bahasa
en-US English (Inggris)
de-DE Deutsch (Jerman)
es-ES Español (Spanyol)
fr-FR Français (Prancis)
hi-IN हिन्दी (Hindi)
id-ID Indonesia
it-IT Italiano (Italia)
ja-JP 日本語 (Jepang)
ko-KR 한국어 (Korea)
pl-PL Polski
pt-BR Português (Portugis)
ru-RU Русский (Rusia)
th-TH ไทย (Thai)
tr-TR Türkçe (Turki)
vi-VN Tiếng Việt (Vietnam)
zh-Hans-CN 简体中文 (Tionghoa)
zh-Hant-TW 繁體中文 (Tionghoa)

Browser modern mengizinkan URL yang sangat panjang, tetapi jika Anda perlu mendukung browser lama dan memotong lebih dari 30 gambar dalam satu sesi, Anda dapat mengirimkannya dalam POST daripada menggunakan tautan langsung.

Contoh URL Gambar Tunggal


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

Saat menentukan gambar tunggal, editor tidak memiliki tombol 'lewati' dan tidak menunjukkan jumlah gambar yang tersisa untuk pemotongan.

Contoh URL Multi-Gambar


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

Saat menentukan beberapa gambar, editor memiliki tombol 'lewati' dan menunjukkan jumlah gambar yang tersisa untuk pemotongan.

Return URL

Saat operator manusia Anda selesai memotong, browser mereka akan mengeluarkan HTTP POST ke Return URL yang Anda tentukan. POST tersebut akan berisi satu parameter di dalam isinya: clippingMagicJson. Saat Anda mengurai konten parameter itu, mereka mengekstrak objek JSON dengan informasi tentang gambar apa yang dipotong. Anda kemudian dapat mengunduh hasil yang sekarang tersedia dengan menggunakan Download Server API.

event
Enum
editor-exit, error

editor-exit berarti sesi pemotongan selesai dengan sukses.

error berarti telah terjadi kesalahan dan error di bawah ini diisi.

images
[{"id":1,"secret":"secret1"},{"id":2,"secret":"secret2"},{"id":3,"secret":"secret3"},{"id":4,"secret":"secret4"}]
Barisan dengan gambar yang disediakan di URL Editor Cerdas yang Dihosting.
clipped
[{"id":1,"secret":"secret1"},{"id":2,"secret":"secret2"}]
Barisan dengan gambar yang benar-benar terpotong dalam sesi ini, yaitu gambar di mana operator manusia mengklik 'Selesai' di editor.
skipped
[{"id":3,"secret":"secret3"},{"id":4,"secret":"secret4"}]
Barisan dengan gambar yang dilewati dalam sesi ini, yaitu gambar di mana operator manusia mengklik 'Lewati' di editor.

Jika event=error, akan ada error objek anggota yang diisi dengan:

error.status
Bilangan Bulat
Kode seperti status HTTP. 4xx berarti kesalahan pemanggil. 5xx berarti kesalahan server internal.
error.code
Bilangan Bulat
Nomor yang secara unik mengidentifikasi kesalahan yang terjadi.
error.message
String
Pesan kesalahan yang dapat dibaca manusia yang menjelaskan kesalahan yang terjadi.

Anda harus menonaktifkan pemeriksaan CSRF atau menambahkan token CSRF ke Return URL agar POST berhasil.

Jika operator manusia Anda menutup browser mereka atau Anda menggunakan URL Editor Cerdas yang Dihosting yang tidak dapat diuraikan, maka URL Pengembalian Anda tidak akan dipanggil.

Contoh Sukses clippingMagicJson diterjemahkan menjadi:
{
  "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" : [ ]
}
Uji Return URL Anda
Contoh Kesalahan clippingMagicJson diterjemahkan menjadi:
{
  "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"
  } ]
}
Uji Return URL Anda