Editor inteligente hospedado

A maneira mais fácil de integrar o editor inteligente do Clipping Magic ao seu fluxo de trabalho personalizado.

Passos para integração

Não deixe de ler o Guia de início rápido primeiro.

  1. Faça upload de uma imagem usando a API de servidor.

  2. Crie um URL do editor inteligente hospedado ou encaminhe seu operador humano para lá, onde ele poderá recortar as imagens que você especificou.

  3. 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.

URL do editor inteligente hospedado 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 id:secret. Você obtém esses pares ao fazer upload de uma imagem usando a API de servidor.

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 useStickySettings=true, o editor usará as configurações duráveis estabelecidas para o usuário cuja chave de API foi usada para o upload da imagem.

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.

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:

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

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=2345:image_secret&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=2345:image_secret,2346: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.

URL de retorno

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

editor-exit indica que a sessão de recorte foi concluída com êxito.

error indica que houve um erro e que este error está informado abaixo.

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 event=error, haverá um objeto membro error preenchido com:

error.status
Inteiro
Código do tipo de status HTTP. 4xx indica um erro do usuário que fez a chamada. 5xx indica um erro interno do servidor.
error.code
Inteiro
Número que identifica exclusivamente o erro ocorrido.
error.message
Cadeia de caracteres
Mensagem de erro inteligível, que descreve o erro ocorrido.

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.

Exemplo de êxito clippingMagicJson é decodificado 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" : [ ]
}
Teste seu URL de retorno
Exemplo de erro clippingMagicJson é decodificado 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"
  } ]
}
Teste seu URL de retorno