Generalidades de API

Clipping Magic ofrece una API orientada en REST para automatizar la carga de imágenes y la descarga de los resultados. Puede integrar el editor de Clipping Magic en su sitio web con ClippingMagic.js para permitir que sus usuarios eliminen fondos directamente desde su sitio web.

La API es especialmente útil para sitios web que necesitan eliminar fondos de las imágenes proporcionadas por usuarios y para sitios web de comercio electrónico que tienen diseñadores gráficos que eliminan fondos de un flujo de imágenes.

Para usar la API necesitará una clave API y algunos conocimientos de programación web.

Teoría de la operación

El usuario final elimina los fondos

La situación típica es que el usuario final carga una imagen a su sitio web y usted quiere darle al usuario la habilidad de eliminar el fondo de esa imagen como parte del flujo de imágenes de su sitio web. Los pasos que normalmente seguiría son:

  1. Cargar la imagen a CliperMagic.com a través de la API backend. Obtener una id y clave secreta de la imagen.

  2. En su sitio web, permitir que el usuario final elimine el fondo con ClippingMagic.js, usando el flujo de trabajo Editar una sola imagen y la id y la clave secreta de la imagen obtenidas en el paso 1.

  3. Al recibir la invocación result-generated de ClippingMagic.js, notificar a su backend para descargar el resultado de esa imagen.

  4. Descargar el resultado y continuar con los pasos subsiguientes del flujo de trabajo específico de su sitio.

El personal interno elimina los fondos

La situación típica es que usted tiene una larga lista de imágenes que necesita procesar y personal para procesarlas. Los pasos que normalmente seguiría serían:

  1. Cargar un conjunto de imágenes a la vez en ClippingMagic.com a través de la API backend. Obtener y almacenar la id y clave secreta de la imagen correspondiente.

  2. En su sitema interno, asignar imágenes al personal en grupos adecuados. Luego dejar que cada empleado elimine el fondo de un grupo con ClippingMagic.js, usando el flujo de trabajo Editar múltiples imágenes en secuencia con las id y claves de las imágenes del paso 1.

    Los tamaños típicos de los grupos varían de entre 10 a 100, dependiendo del volumen y los particulares de sus imágenes.

  3. Al recibir las invocaciones result-generated de ClippingMagic.js, notificar a su backend para descargar el resultado de esa imagen.

  4. Enjuagar y repetir.

Backend contra Frontend

Todas las operaciones de carga y descarga suceden en el backend, pero todas las operaciones de recorte suceden en el cliente web (frontend) usando ClippingMagic.js.

Esta división protege su clave API mientras que permite que el usuario final tenga una experiencia ininterrumpida en su sitio.

Detalles

  • Puede usar la API en modo de prueba sin inscribirse, pero para realmente poder usarla necesita una suscripción API.
  • Lo sentimos, las suscripciones regulares web no incluyen acceso a API.
  • Puede ver y editar todas las imágenes cargadas a través de la API en el sitio web principal de Clipping Magic (cuando inicia una sesión como usuario de la API) y viceversa. Esto puede ser muy útil durante la depuración o si necesita revisar el flujo de imágenes de la API.
  • Aunque la API no tiene limitaciones de tarifa, por favor sea cortés y no se aproveche.
  • Su biblioteca cliente de http debe ser compatible con la Indicación de nombre del servidor (SNI) para poder hacer peticiones. Si tiene errores raros de protocolo de enlace, esta es la razón más probable.

Comentarios

¿Hace falta algo o hay insuficiente documentación? ¿Su implementación requiere otras funciones adicionales?

Avísenosy trataremos de corregirlo.

Error de Javascript :-(


¡Ayúdenos a corregir este problema!