Hosted-Smart-Editor

Die leichteste Methode zur Integration des Clipping Magic-Smart-Editors in Ihren benutzerspezifischen Workflow.

Integrationsschritte

Lesen Sie zuerst den Abschnitt Schnellstart.

  1. Laden Sie ein Bild über die Server-API hoch.

  2. Erstellen Sie eine URL des Hosted-Smart-Editors und verweisen Sie Ihren menschlichen Bediener darauf; dort kann er die von Ihnen vorgegebenen Bilder beschneiden.

  3. Nach dem Beschneiden aller Bilder navigiert Ihr menschlicher Bediener zur vorgegebenen Rückgabe-URL mit einem HTTP POST, der die relevanten Informationen zur Clipping-Sitzung enthält.

Wenn Sie eine White-Label-Lösung oder einen Rückruf für jedes beschnittene Bild benötigen, beziehen Sie sich bitte auf den White-Label-Smart-Editor.

URL des Hosted-Smart-Editors https://clippingmagic.com/api/v1/hosted/[apiId]

Sie können eine einfache URL erstellen und Ihren menschlichen Bediener anweisen, sie in seinem Browser zu öffnen, damit er ein oder mehrere Bilder prüfen und bearbeiten kann.

Die URL des Hosted-Smart-Editors unterstützt folgende Parameter:

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

Die zu beschneidenden Bilder. Eine durch Komma getrennte Liste von id:secret Paaren. Diese erhalten Sie durch Hochladen eines Bildes über die Server-API.

returnUrl
Zeichenfolge
Erforderlich

Wenn Ihr menschlicher Bediener mit dem Beschneidevorgang fertig ist, gibt der Browser ein HTTP POST an diese URL aus. Einzelheiten dazu finden Sie weiter unten.

useStickySettings
Boolesch
true, false

Wenn Sie useStickySettings=true übergeben, verwendet der Editor die die persistenten Einstellungen, die derzeit für den Benutzer konfiguriert sind, dessen API-Schlüssel zum Hochladen des Bildes verwendet wurde.

Damit können Sie die grundlegenden Clipping-Einstellungen einmal konfigurieren, worauf sie anschließend für alle von Ihnen bearbeiteten Bilder übernommen werden.

Read about how to configure the sticky settings

„Vorab zuschneiden“ ist über die API nicht verfügbar, aber Sie können das Bildgrößenlimit im API-Upload-Abruf konfigurieren.

locale
Zeichenfolge

Die für den Editor zu verwendende Anzeigesprache. Wird standardmäßig auf Englisch gesetzt, wenn keine Auswahl getroffen wird. Gültige Werte sind:

CodeAnzeigesprache
en-US English (Englisch)
de-DE Deutsch
es-ES Español (Spanisch)
fr-FR Français (Französisch)
hi-IN हिन्दी (Hindi)
id-ID Indonesia (Indonesisch)
it-IT Italiano (Italienisch)
ja-JP 日本語 (Japanisch)
ko-KR 한국어 (Koreanisch)
pl-PL Polski (Polnisch)
pt-BR Português (Portugiesisch)
ru-RU Русский (Russisch)
th-TH ไทย (Thailändisch)
tr-TR Türkçe (Türkisch)
vi-VN Tiếng Việt (Vietnamesisch)
zh-Hans-CN 简体中文 (Chinesisch)
zh-Hant-TW 繁體中文 (Chinesisch)

Moderne Browser unterstützen sehr lange URLs, aber wenn Sie Legacy-Browser unterstützen und mehr als 30 Bilder in einer Sitzung beschneiden müssen, können Sie diese über ein POST anstatt eines direkten Links einreichen.

URL-Beispiel mit Einzelbild


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

Bei Vorgabe eines Einzelbildes hat der Editor keine Schaltfläche zum „Überspringen“ und zeigt nicht die verbleibende Anzahl von Bildern an, die noch zu beschneiden sind.

URL-Beispiel mit mehreren Bildern


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

Bei Vorgabe von mehreren Bildern hat der Editor eine Schaltfläche zum „Überspringen“ und zeigt die verbleibende Anzahl von Bildern an, die noch zu beschneiden sind.

Rückgabe-URL

Wenn Ihr menschlicher Bediener den Beschneidevorgang beendet hat, gibt sein Browser ein HTTP POST an die von Ihnen vorgegebene Rückgabe-URL aus. Dieses POST enthält in seinem Hauptteil einen einzelnen Parameter: clippingMagicJson. Wird der Inhalt dieses Parameters geparst, wird er in ein JSON-Objekt entpackt, das Informationen dazu enthält, welche Bilder beschnitten wurden. Daraufhin können Sie die jetzt verfügbaren Ergebnisse durch Verwendung der Download-Server-API herunterladen.

event
Enum
editor-exit, error

editor-exit bedeutet, dass die Beschneidesitzung erfolgreich abgeschlossen wurde.

error bedeutet, dass ein Fehler aufgetreten ist und dieser error Fehler wie weiter unten dargestellt ausgefüllt ist.

images
[{"id":1,"secret":"secret1"},{"id":2,"secret":"secret2"},{"id":3,"secret":"secret3"},{"id":4,"secret":"secret4"}]
Ein Array mit den in der URL des Hosted-Smart-Editors bereitgestellten Bildern.
clipped
[{"id":1,"secret":"secret1"},{"id":2,"secret":"secret2"}]
Ein Array mit denjenigen Bildern, die tatsächlich in dieser Sitzung beschnitten wurden, d. h. diejenigen Bilder, bei denen der menschliche Bediener im Editor auf „Fertig“ geklickt hat.
skipped
[{"id":3,"secret":"secret3"},{"id":4,"secret":"secret4"}]
Ein Array mit denjenigen Bildern, die in dieser Sitzung übersprungen wurden, d. h. diejenigen Bilder, bei denen der menschliche Bediener im Editor auf „Überspringen“ geklickt hat.

Wenn event=error, gibt es ein error Memberobjekt, das wie folgt ausgefüllt ist:

error.status
Ganzzahl
HTTP-Status-ähnlicher Code. 4xx bedeutet einen Aufruferfehler. 5xx bedeutet einen internen Serverfehler.
error.code
Ganzzahl
Zahl, die den aufgetretenen Fehler eindeutig identifiziert.
error.message
Zeichenfolge
Visuell lesbare Fehlermeldung, die den aufgetretenen Fehler beschreibt.

Sie müssen entweder alle CSRF-Prüfungen deaktivieren oder das CSRF-Token der Rückgabe-URL hinzufügen, damit das POST erfolgreich ist.

Wenn der Bediener seinen Browser schließt oder wenn Sie eine nicht parsbare Hosted-Smart-Editor-URL verwenden, wird Ihre Rückgabe-URL nicht aufgerufen.

Beispiel für Erfolg clippingMagicJson wird decodiert in:
{
  "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" : [ ]
}
Testen Sie Ihre Rückgabe-URL
Beispiel für Fehler clippingMagicJson wird decodiert in:
{
  "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"
  } ]
}
Testen Sie Ihre Rückgabe-URL