Présentation d'API

Clipping Magic offre une API Web orientée REST pour automatiser le téléchargement en amont des images et le téléchargement en aval des résultats. Vous pouvez intégrer l'éditeur Clipping Magic dans votre site Web avec ClippingMagic.js pour permettre à vos utilisateurs de supprimer les arrière-plans directement sur votre site Web.

L'API est particulièrement utile pour les sites Web qui doivent supprimer les arrière-plans des images fournies par l'utilisateur, et pour les sites Web de commerce en ligne dont les graphistes ont la tâche de supprimer les arrière-plans sur un flux d'images.

Pour utiliser l'API, une clé API est requise, ainsi que certaines compétences en matière de programmation Web.

Principe de fonctionnement

L'utilisateur final supprime les arrière-plans

Le scénario typique est le suivant : un utilisateur final télécharge en amont une image sur votre site, et vous souhaitez lui permettre de retirer l'arrière-plan de l'image en utilisant les outils de traitement des images de votre site. Les étapes habituelles sont les suivantes :

  1. Votre utilisateur télécharge une image sur votre site Web.

  2. Votre serveur dorsal transfère l'image à ClippingMagic.com via l'API dorsale et reçoit un identifiant d'image et une clé secrète en retour.

    Votre client Web ne peut pas télécharger directement l'image sur ClippingMagic.com pour des raisons de sécurité.

  3. Votre serveur dorsal fait parvenir l'identifiant de l'image et la clé secrète à votre client Web. Si vous utilisez AJAX, ces informations peuvent être incluses dans la réponse au téléchargement de l'image. Elles peuvent autrement être intégrées dans la page Web que vous restituez en réponse au téléchargement d'image de l'utilisateur.

  4. Sur votre site, laissez l'utilisateur final retirer l'arrière-plan avec ClippingMagic.js, en laissant votre code javascript invoquer le processus Modifier une seule image, ainsi que l'identifiant et la clé secrète de l'image obtenus à l'étape précédente.

  5. Sur réception du rappel result-generated de ClippingMagic.js, votre code javascript signale à votre serveur dorsal de télécharger le résultat de cette image.

  6. Votre serveur dorsal télécharge le résultat et continue les étapes suivantes du processus spécifique à votre site.

Le personnel travaillant en interne supprime les arrière-plans

Le scénario typique est le suivant : vous avez une longue liste d'images à traiter, et vous disposez d'un personnel pour le faire. Les étapes habituelles sont les suivantes :

  1. Téléchargez un lot d'images une à la fois sur ClippingMagic.com via l'API du serveur dorsal. Obtenez les identifiants et les clés secrètes des images respectives et enregistrez-les.

  2. Dans votre système interne, assignez les images aux serveurs de travail par lots adaptés. Laissez ensuite chaque serveur de travail retirer les arrière-plans d'un lot d'images azvec ClippingMagic.js, en utilisant l'outil Modifier plusieurs images en séquence avec les identifiants et les clés secrètes des images obtenus à l'étape 1.

    Les tailles de lot typiques varient entre 10 et 100, en fonction du volume et des caractéristiques des images.

  3. Sur réception des rappels result-generated de ClippingMagic.js, signalez à votre serveur dorsal de télécharger le résultat de cette image.

  4. Répétez les étapes pour toutes les images.

Dorsal/Frontal

Veuillez noter que toutes les opérations de téléchargement en amont et en aval se produisent sur le serveur dorsal, mais que toutes les opérations de découpage ont lieu sur le client Web (frontal) à l'aide de ClippingMagic.js.

Cette distinction protège votre clé API, tout en offrant à l'utilisateur un déroulement des opérations fluide.

Détails

  • Vous pouvez utiliser l'API en mode d'essai sans abonnement, mais pour l'utiliser véritablement, vous devrez souscrire à un abonnement API.
  • Nous sommes désolés, mais les abonnements standard au site Web n'offrent pas d'accès API.
  • Vous pouvez visualiser et modifier toutes les images téléchargées via l'API sur le site Web Clipping Magic principal (lorsque vous êtes connectés en tant qu'utilisateur API) et vice-versa. Ceci peut être très utile pour la résolution des erreurs, ou si vous souhaitez consulter le flux d'images API.
  • Bien qu'il n'y ait aucune limite imposée sur l'API, veuillez rester courtois et ne pas en abuser.
  • Votre bibliothèque des clients http doit prendre en charge le SNI (Server Name Indication) pour que les requêtes puissent être adressées. Si vous recevez d'étranges erreurs de protocole d'accord (handshake), c'est très probablement le cas.

Commentaires

Manque-t-il un renseignement ou une explication ? Des fonctionnalités supplémentaires sont-elles requises pour mener votre tâche à bien ?

Veuillez nous communiquer votre problème pour que nous puissions le résoudre.