Editor intelligente ospitato

Il modo migliore per integrare l'Editor intelligente Clipping Magic nel tuo flusso di lavoro personalizzato.

Passi per l'Integrazione

Leggi prima la guida di Avvio rapido.

  1. Carica un'immagine usando l'API server.

  2. Crea un URL Editor intelligente ospitato e comunicalo al tuo operatore umano, quando ritaglia le immagini che specifichi.

  3. Dopo aver ritagliato tutte le immagini, il browser del tuo operatore umano naviga a URL ritorno specificato con un HTTP POST che contiene le informazioni rilevanti dopo la sessione di ritaglio.

Se hai bisogno di una soluzione di etichetta bianca o un callback per ogni immagine ritagliata, dai un'occhiata a Editor intelligente etichetta bianca.

URL Editor intelligente ospitato https://clippingmagic.com/api/v1/hosted/[apiId]

Puoi creare un semplice URL e farlo aprire dal tuo operatore umano nel suo browser in modo che possa esaminare e modificare una o più immagini.

URL Editor intelligente ospitato supporta i seguenti parametri:

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

Le immagini da ritagliare. Un elenco separato da virgola delle coppie id:secret. Puoi ottenerle caricando un'immagine usando l'API server.

returnUrl
Stringa
Obbligatorio

Quando il tuo operatore umano ha finito di ritagliare, il suo browser rilascia un HTTP POST per questo URL. Vedi i dettagli sotto.

useStickySettings
Boleano
true, false

Se passi a useStickySettings=true l'editor userà le scorciatoie attualmente configurate per l'utente la cui chiave API è stata usata per caricare l'immagine.

Ciò ti consente di configurare le impostazioni dei ritagli una volta, e quindi applicarli a tutte le immagini che modifichi.

Read about how to configure the sticky settings

Pre-ritaglio non è disponibile tramite API, ma puoi configurare il limite delle dimensioni dell'immagine nella chiamata di caricamento API.

locale
Stringa

La lingua di visualizzazione da usare per l'editor. Se omessa, la lingua è automaticamente l'Inglese. I valori validi sono:

CodiceLingua di visualizzazione
en-US English (inglese)
de-DE Deutsch (tedesco)
es-ES Español (spagnolo)
fr-FR Français (francese)
hi-IN हिन्दी (hindi)
id-ID Indonesia (indonesiano)
it-IT Italiano (italiano)
ja-JP 日本語 (giapponese)
ko-KR 한국어 (coreano)
pl-PL Polski (polacco)
pt-BR Português (portoghese)
ru-RU Русский (russo)
th-TH ไทย (thai)
tr-TR Türkçe (turco)
vi-VN Tiếng Việt (vietnamita)
zh-Hans-CN 简体中文 (cinese)
zh-Hant-TW 繁體中文 (cinese)

I browser moderni consentono URL molto lunghi ma se devi supportare browser legacy e ritagliare più di 30 immagini in una sessione, devi inoltrarle in un POST invece di usare un link diretto.

Esempio di URL di un'immagine singola


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

Quando specifichi un'immagine singola l'editor non ha un pulsante 'ignora' e non mostra il numero di immagini da ritagliare rimaste.

Esempio di URL per diverse immagini


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

Quando specifichi diverse immagini, l'editor dispone di un pulsante 'ignora' e mostra il numero di immagini da ritagliare rimaste.

URL ritorno

Quando il tuo operatore umano ha finito di ritagliare, il suo browser rilascia un HTTP POST a URL ritorno che specifichi. Quel POST conterrà un solo parametro: clippingMagicJson. Quando analizzi il contenuto di quel parametro, si decomprime in un oggetto JSON con informazioni sulle immagini che sono state ritagliate. Puoi scaricare i risultati ora disponibili usando Scarica API server.

event
Enum
editor-exit, error

editor-exit indica che la sessione di ritaglio si è conclusa soddisfacentemente.

error indica un errore e che error è popolato.

images
[{"id":1,"secret":"secret1"},{"id":2,"secret":"secret2"},{"id":3,"secret":"secret3"},{"id":4,"secret":"secret4"}]
Un array con le immagini fornite nell'URL Editor intelligente ospitato.
clipped
[{"id":1,"secret":"secret1"},{"id":2,"secret":"secret2"}]
Un array con le immagini effettivamente ritagliate in questa session, vale a dire le immagini per cui l'operatore umano ha cliccato 'Fatto' nell'editor.
skipped
[{"id":3,"secret":"secret3"},{"id":4,"secret":"secret4"}]
Un array con le immagini ignorate in questa sessione, vale a dire le immagini per cui l'operatore umano ha cliccato 'Ignora' nell'editor.

Se event=error, esiste un error oggetto membro popolato con:

error.status
Intero
Codice HTTP simile a status. 4xx indica un errore. 5xx indica un errore del server interno.
error.code
Intero
Numero che identifica univocamente l'errore che si è verificato.
error.message
Stringa
Messaggio di errore leggibile dall'uomo, che descrive l'errore che si è verificato.

Devi disabilitare qualsiasi controllo CSRF o aggiungere il token CSRF all' URL ritorno perché il POST riesca.

Se il tuo operatore umano chiude il suo browser o usa un URL Editor intelligente ospitato che non può essere analizzato, l'URL di ritorno non può essere chiamato.

Esempio di successo clippingMagicJson decodifica a:
{
  "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" : [ ]
}
Prova il tuo URL di ritorno
Esempio di errore clippingMagicJson decodifica a:
{
  "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"
  } ]
}
Prova il tuo URL di ritorno