Visão geral da API

Clipping Magic oferece uma Web API orientada a REST para automatizar o upload e o download de resultados. Você pode integrar o editor do Clipping Magic no seu site com ClippingMagic.js para permitir que seus usuários removam fundos diretamente no seu site.

A API é útil especialmente para sites que precisam remover fundos de imagens fornecidas pelo usuário e para sites de comércio eletrônico com uma equipe de designers gráficos que remove fundos de imagens em um fluxo de imagens.

Para usar a API, você precisará de uma chave de API e alguns conhecimentos de programação para a web.

Teoria de operação

Usuário final remove fundos

A situação usual é que o usuário faz upload de uma imagem no seu site e, como parte do fluxo de trabalho de imagens no seu site, você quer permitir que o usuário remova o fundo dessa imagem. Normalmente, as etapas realizadas seriam:

  1. Seu usuário faz upload de uma imagem para o seu site.

  2. Seu servidor de back-end passa a imagem ao ClippingMagic.com via a API de back-end e recebe de volta um identificador de imagem e uma chave secreta.

    Seu cliente da web não pode fazer upload da imagem diretamente ao ClippingMagic.com por razões de segurança.

  3. O servidor de back-end passa o identificador da imagem e a chave secreta ao seu cliente da web. Se você estiver usando AJAX, essas informações podem ser incluídas na resposta ao upload da imagem. Caso contrário, serão inseridas na página da web processada em resposta ao upload da imagem do usuário.

  4. No seu site, permita que o usuário final remova o fundo com o ClippingMagic.js com o código javascript que ativa o fluxo de trabalho Editar uma única imagem, com o identificador de imagem e a chave secreta do passo anterior.

  5. Ao receber o result-generated do callback do ClippingMagic.js, seu código javascript notifica o back-end para fazer download do resultado daquela imagem.

  6. O servidor de back-end faz download do resultado e executa os passos subsequentes do fluxo de trabalho específico do seu site.

Equipe interna remove fundos

A situação usual é que você tem uma longa lista de imagens para processar e algumas pessoas para processá-la. Normalmente, as etapas realizadas seriam:

  1. Fazer upload de um lote de imagens em ClippingMagic.com, uma por vez, usando a API the back-end. Obter e armazenar os respectivos identificadores e chaves secretas das imagens.

  2. No seu sistema interno, alocar lotes adequados de imagens aos profissionais. Deixar que cada profissional remova os fundos de um lote com ClippingMagic.js, usando o fluxo de trabalho Editar várias imagens em sequência, com os identificadores e chaves secretas de imagens obtidos na etapa 1.

    Em geral, o tamanho dos lotes varia entre 10 e 100, dependendo do volume e das características das suas imagens.

  3. Ao receber os callbacks result-generated de ClippingMagic.js, notificar seu back-end para fazer download do resultado para a imagem.

  4. Repetir quantas vezes necessário.

Back-end contra front-end

Note que todas as operações de download ocorrem no back-end, mas todas as operações de recorte acontecem no cliente web (front-end) usando ClippingMagic.js.

Essa divisão protege sua chave de API, além de possibilitar uma experiência contínua para o usuário do seu site.

Detalhes

  • Você pode utilizar a API no modo de teste sem ser assinante, mas para usá-la em produção, você precisará fazer uma assinatura de API.
  • As assinaturas regulares do site não incluem o acesso de API.
  • Você pode ver e editar todas as imagens cujo upload foi feito pela API no site principal do Clipping Magic (quando fizer login como usuário de API) ou usando a própria API. Isso pode ser muito útil para depuração ou se você precisar revisar o fluxo de imagem da API.
  • Embora a API não tenha limites de taxa, tenha consideração pelos outros usuários e não sobrecarregue demais o sistema.
  • Sua biblioteca de cliente HTTP deve aceitar Indicação de Nome do Servidor (SNI) para fazer requisições corretamente. Se você estiver recebendo erros de handshake estranhos, provavelmente esta é a causa.

Comentários

Falta algo ou a documentação é insuficiente? Sua implementação precisa de recursos adicionais?

Fale conosco. Nós tentaremos resolver.