A maneira mais fácil de integrar o editor inteligente do Clipping Magic ao seu fluxo de trabalho personalizado.
Não deixe de ler o Guia de início rápido primeiro.
Faça upload de uma imagem usando a API de servidor.
Crie um URL do editor inteligente hospedado ou encaminhe seu operador humano para lá, onde ele poderá recortar as imagens que você especificou.
Após recortar todas as imagens, o navegador do seu operador humano navega até o URL de retorno especificado com um HTTP POST contendo as informações relevantes sobre a sessão de recorte.
Se precisar de uma solução de marca branca ou um chamada de retorno para cada imagem recortada, consulte a seção Editor inteligente de marca branca.
https://clippingmagic.com/api/v1/hosted/[apiId]
É possível criar um URL simples para que seu operador abra no navegador para revisar e editar uma ou mais imagens.
O URL do editor inteligente hospedado aceita os seguintes parâmetros:
|
images
id1:secret1,id2:secret2,... 123:abc,456:def
Obrigatório |
As imagens para recortar. Uma lista separada por vírgulas de pares |
||||||||||||||||||||||||||||||||||||
|
returnUrl
Cadeia de caracteres Obrigatório |
Quando o operador humano terminar de recortar, o navegador emitirá um HTTP POST para esse URL. Veja mais detalhes abaixo. |
||||||||||||||||||||||||||||||||||||
|
useStickySettings
Boleano true, false
|
Se você passar Isso permite definir as configurações de recorte uma só vez e aplicá-las a todas as imagens que você editar. Read about how to configure the sticky settings O corte prévio não está disponível pela API, mas você pode configurar o limite do tamanho da imagem na chamada de upload da API.
Padrão: |
||||||||||||||||||||||||||||||||||||
|
hideBottomToolbar
Boleano true, false
|
Oculta a barra de ferramentas inferior, o que torna essas configurações indisponíveis no editor.
Padrão: |
||||||||||||||||||||||||||||||||||||
|
locale
Cadeia de caracteres |
O idioma usado na exibição do editor. Se omitido, o padrão é inglês. Os valores válidos são:
|
Os navegadores modernos aceitam URL bastante longos, mas se você precisar oferecer suporte para navegadores legados e recortar mais de 30 imagens em uma sessão, envie-nas em POST em vez de usar um link direto.
Exemplo de URL com apenas uma imagem
https://clippingmagic.com/api/v1/hosted/123?images=2346:image_secret1&returnUrl=https%3A%2F%2Fclippingmagic.com%2Fapi%2FreturnUrlExample
Ao especificar uma só imagem, o editor não oferece o botão "ignorar" e não mostra o número de imagens remanescente para recorte.
Exemplo de URL com múltiplas imagens
https://clippingmagic.com/api/v1/hosted/123?images=2346:image_secret1,2347:image_secret2&returnUrl=https%3A%2F%2Fclippingmagic.com%2Fapi%2FreturnUrlExample
Ao especificar imagens múltiplas, o editor tem o botão "ignorar" e mostra o número de imagens remanescentes para recorte.
Quando o operador humano terminar de recortar, o navegador dele emitirá um HTTP POST para o URL de retorno que você especificar. Esse POST conterá um só parâmetro no corpo: clippingMagicJson. Quando o conteúdo desse parâmetro é interpretado, ele é desempacotado em um objeto JSON com informações sobre as imagens que foram recortadas. Para fazer download dos resultados que agora já estão disponíveis, use a API de servidor para download.
|
event
Enum editor-exit, error
|
|
||||||
|
images
[{"id":1,"secret":"secret1"},{"id":2,"secret":"secret2"},{"id":3,"secret":"secret3"},{"id":4,"secret":"secret4"}] |
Uma série com as imagens fornecidas no URL do editor inteligente hospedado. | ||||||
|
clipped
[{"id":1,"secret":"secret1"},{"id":2,"secret":"secret2"}] |
Uma série com as imagens efetivamente recortadas na sessão, ou seja, as imagens nas quais o operador humano clicou "Concluído" no editor. | ||||||
|
skipped
[{"id":3,"secret":"secret3"},{"id":4,"secret":"secret4"}] |
Uma série com as imagens ignoradas na sessão, ou seja, as imagens nas quais o operador humano clicou "Ignorar" no editor. | ||||||
|
Se
|
|||||||
Você precisará desabilitar verificações de CSRF ou adicionar o token CSRF ao URL de retorno para ter êxito no POST.
Se o operador humano fechar o navegador ou se você usar um URL de editor inteligente hospedado não interpretável, o URL de retorno não será chamado.
clippingMagicJson é decodificado 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 é decodificado 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"
} ]
}