Editor inteligente hospedado

Es la manera más fácil de integrar el Editor inteligente de Clipping Magic en su flujo de trabajo personalizado.

Pasos para la integración

Lea primero la sección Inicio rápido.

  1. Cargue una imagen usando la API del servidor.

  2. Cree una dirección URL del Editor inteligente hospedado y remita a su operador humano ahí, en donde recortará las imágenes que usted especifique.

  3. Después de recortar todas las imágenes, el explorador de su operador humano navega a la Dirección URL de retorno especificada con un POST de HTTP que contiene la información pertinente sobre la sesión de recorte.

Si necesita una solución de marca blanca o un devolución de llamada para cada imagen recortada, consulte la información sobre el Editor inteligente de marca blanca.

URL del Editor inteligente hospedado https://clippingmagic.com/api/v1/hosted/[apiId]

Puede crear un URL sencillo y que su operador humano lo abra en su explorador para revisar y editar una o más de sus imágenes.

El URL del Editor inteligente hospedado acepta los siguientes parámetros:

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

Las imágenes por recortar. Una lista de pares id:secret separados por comas. Estos se obtienen al cargar una imagen usando la API del servidor.

returnUrl
Cadena
Obligatorio

Cuando el operador humano termine de recortar, el explorador del operador enviará un HTTP POST a este URL. Vea los detalles abajo.

useStickySettings
Booleano
true, false

Si define useStickySettings=true, el editor usará la configuración actual del usuario cuya clave API se usó para cargar la imagen.

Esto le permite configurar una sola vez la configuración de base para recortar y luego se aplica a todas las imágenes que edite.

Read about how to configure the sticky settings

Precortar no está disponible a través de la API, pero puede configurar el límite del tamaño de imagen en la invocación de carga de la API.

locale
Cadena

El idioma de presentación para usar para el editor. El idioma predeterminado es inglés si se omite. Los valores válidos son:

CódigoIdioma para mostrar
en-US English (inglés)
de-DE Deutsch (alemán)
es-ES Español (español)
fr-FR Français (francés)
hi-IN हिन्दी (hindi)
id-ID Indonesia (indonesio)
it-IT Italiano (italiano)
ja-JP 日本語 (japonés)
ko-KR 한국어 (coreano)
pl-PL Polski (polaco)
pt-BR Português (portugués)
ru-RU Русский (ruso)
th-TH ไทย (tailandés)
tr-TR Türkçe (turco)
vi-VN Tiếng Việt (vietnamita)
zh-Hans-CN 简体中文 (chino)
zh-Hant-TW 繁體中文 (chino)

Los exploradores modernos permiten direcciones URL muy largas, pero si necesita tener compatibilidad con exploradores antiguos y recorta más de 30 imágenes en una sesión, puede enviarlas en un POST en lugar de usar el enlace directo.

Ejemplo de URL con una sola imagen


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

Al especificar una sola imagen, el editor no tiene un botón 'Omitir' y no muestra la cantidad de imágenes que aún quedan por recortar.

Ejemplo de URL con múltiples imágenes


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

Al especificar múltiples imágenes, el editor tiene un botón 'Omitir' y muestra la cantidad de imágenes que aún quedan por recortar.

Dirección URL de retorno

Cuando su operador humano termine de recortar, el explorador del operador enviará un HTTP POST al Dirección URL de retorno que usted especifique. Ese POST contendrá un solo parámetro en el cuerpo: clippingMagicJson. Cuando se analiza el contenido de ese parámetro, se desempaqueta en un objeto JSON con información sobre las imágenes que se recortaron. Entonces podrá descargar los resultados ahora disponibles usando la API del servidor de descarga.

event
Enum
editor-exit, error

editor-exit significa que la sesión de recorte concluyó con éxito.

error significa que ocurrió un error y que se rellena error abajo.

images
[{"id":1,"secret":"secret1"},{"id":2,"secret":"secret2"},{"id":3,"secret":"secret3"},{"id":4,"secret":"secret4"}]
Una matriz con las imágenes proporcionadas en el URL del Editor inteligente hospedado.
clipped
[{"id":1,"secret":"secret1"},{"id":2,"secret":"secret2"}]
Una matriz con las imágenes que se recortaron en esta sesión; es decir, las imágenes en las que el operador humano hizo clic en 'Terminado', en el editor.
skipped
[{"id":3,"secret":"secret3"},{"id":4,"secret":"secret4"}]
Una matriz con las imágenes saltadas en esta sesión; es decir, las imágenes en las que el operador humano hizo clic en 'Saltar', en el editor.

Si event=error, se rellenará el objeto miembro de error con:

error.status
Entero
Código similar al estatus de HTTP. 4xx significa error de llamada. 5xx significa un error del servidor interno.
error.code
Entero
Número que identifica de manera exclusiva el error que ocurrió.
error.message
Cadena
Mensaje de error que un humano puede leer y que describe el error ocurrido.

Tendrá que deshabilitar las verificaciones de CSRF o agregar el token de CSRF a la Dirección URL de retorno para que el POST tenga éxito.

Si su operador humano cierra su explorador o si usted usa un URL del Editor inteligente hospedado que no se puede analizar, entonces no se invocará al URL de retorno.

Ejemplo de éxito clippingMagicJson se descodifica como:
{
  "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" : [ ]
}
Pruebe su dirección URL de retorno
Ejemplo de error clippingMagicJson se descodifica como:
{
  "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"
  } ]
}
Pruebe su dirección URL de retorno