Es la manera más fácil de integrar el Editor inteligente de Clipping Magic en su flujo de trabajo personalizado.
Lea primero la sección Inicio rápido.
Cargue una imagen usando la API del servidor.
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.
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.
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 |
||||||||||||||||||||||||||||||||||||
|
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 pasa en 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.
Opción predeterminada: |
||||||||||||||||||||||||||||||||||||
|
hideBottomToolbar
Booleano true, false
|
Oculta la barra de herramientas inferior, por lo cual esas configuraciones no estarán disponibles en el editor.
Opción predeterminada: |
||||||||||||||||||||||||||||||||||||
|
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:
|
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 vínculo directo.
Ejemplo de URL con una sola imagen
https://clippingmagic.com/api/v1/hosted/123?images=2346:image_secret1&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=2346:image_secret1,2347: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.
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
|
|
||||||
|
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
|
|||||||
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.
clippingMagicJson se descodifica como:
{
"event" : "editor-exit",
"images" : [ {
"id" : 2346,
"secret" : "image_secret1"
}, {
"id" : 2347,
"secret" : "image_secret2"
} ],
"clipped" : [ {
"id" : 2346,
"secret" : "image_secret1"
}, {
"id" : 2347,
"secret" : "image_secret2"
} ],
"skipped" : [ ]
}
clippingMagicJson se descodifica como:
{
"event" : "error",
"error" : {
"status" : 400,
"code" : 1234,
"message" : "Example error"
},
"images" : [ {
"id" : 2346,
"secret" : "image_secret1"
}, {
"id" : 2347,
"secret" : "image_secret2"
} ],
"clipped" : [ ],
"skipped" : [ {
"id" : 2346,
"secret" : "image_secret1"
}, {
"id" : 2347,
"secret" : "image_secret2"
} ]
}