La méthode la plus facile d'intégrer l'éditeur intelligent Clipping Magic dans votre flux de travail personnalisé.
Avant tout, veillez à lire la section Démarrage rapide.
Téléchargez une image en utilisant l'API du serveur.
Créez une URL de l'Éditeur intelligent hébergé et transmettez-là à votre opérateur humain pour qu'il puisse y détourer les images spécifiées.
Après avoir découpé toutes les images, le navigateur de votre opérateur humain accède à l'URL de retour spécifiée avec un HTTP POST contenant les informations pertinentes sur la session de détourage.
Si vous souhaitez une solution de marque blanche ou un rappel pour chaque image détourée, consultez l'Éditeur intelligent de marque blanche.
https://clippingmagic.com/api/v1/hosted/[apiId]
Vous pouvez créer une URL simple et demander à votre opérateur humain de l'ouvrir dans son navigateur pour qu'il examine et modifie une ou plusieurs de vos images.
L'URL de l'Éditeur intelligent hébergé prend en charge les paramètres suivants :
|
images
id1:secret1,id2:secret2,... 123:abc,456:def
Requis |
Les images à découper. Une liste de paires |
||||||||||||||||||||||||||||||||||||
|
returnUrl
Chaîne Requis |
Une fois que l'opérateur humain a fini de détourer, son navigateur crée un HTTP POST sur cette URL. Voir les détails ci-dessous. |
||||||||||||||||||||||||||||||||||||
|
useStickySettings
Booléen true, false
|
Si vous indiquez Cela vous permet de configurer les réglages de découpage de base une seule fois, puis de les appliquer à toutes les images que vous modifiez. Read about how to configure the sticky settings Le précadrage n'est pas disponible via l'API, mais vous pouvez configurer la limite de taille d'image dans l'appel de téléchargement de l'API.
Défaut : |
||||||||||||||||||||||||||||||||||||
|
hideBottomToolbar
Booléen true, false
|
Masque la barre d'outils inférieure de l'éditeur, rendant ainsi ces paramètres indisponibles dans l'éditeur.
Défaut : |
||||||||||||||||||||||||||||||||||||
|
locale
Chaîne |
La langue d'affichage à utiliser pour l'éditeur. La langue par défaut est l'anglais, si aucune langue n'est indiquée. Les valeurs valides sont :
|
Les navigateurs modernes autorisent des URL très longues, mais si vous devez prendre en charge d'anciens navigateurs et extraire plus de 30 images en une seule session, vous pouvez les soumettre dans un POST au lieu d'utiliser un lien direct.
Exemple d'URL d'image unique
https://clippingmagic.com/api/v1/hosted/123?images=2346:image_secret1&returnUrl=https%3A%2F%2Fclippingmagic.com%2Fapi%2FreturnUrlExample
Lorsque vous spécifiez une seule image, l'éditeur n'a pas de bouton « ignorer » et n'affiche pas le nombre d'images restantes à découper.
Exemple d'URL d'images multiples
https://clippingmagic.com/api/v1/hosted/123?images=2346:image_secret1,2347:image_secret2&returnUrl=https%3A%2F%2Fclippingmagic.com%2Fapi%2FreturnUrlExample
Lorsque vous spécifiez plusieurs images, l'éditeur dispose d'un bouton « ignorer » et affiche le nombre d'images restantes à découper.
Lorsque votre opérateur humain a terminé le découpage, son navigateur émettra un HTTP POST à l'URL de retour que vous spécifiez. Ce POST contiendra un seul paramètre dans son corps : clippingMagicJson Lorsque vous analysez le contenu de ce paramètre, il est décompressé dans un objet JSON avec des informations sur les images qui ont été détourées. Vous pouvez ensuite télécharger les résultats maintenant disponibles en utilisant l''API du serveur de téléchargement.
|
event
Énuméré editor-exit, error
|
|
||||||
|
images
[{"id":1,"secret":"secret1"},{"id":2,"secret":"secret2"},{"id":3,"secret":"secret3"},{"id":4,"secret":"secret4"}] |
Un tableau avec les images fournies dans l'URL de l'Éditeur intelligent hébergé. | ||||||
|
clipped
[{"id":1,"secret":"secret1"},{"id":2,"secret":"secret2"}] |
Un tableau avec les images effectivement détourées dans cette session, c'est-à-dire les images pour lesquelles l'opérateur humain a cliqué sur « Terminé » dans l'éditeur. | ||||||
|
skipped
[{"id":3,"secret":"secret3"},{"id":4,"secret":"secret4"}] |
Un tableau avec les images ignorées dans cette session, c'est-à-dire les images où l'opérateur humain a cliqué sur 'Ignorer' dans l'éditeur. | ||||||
|
Si
|
|||||||
Vous devrez soit désactiver tous les contrôles CSRF ou ajouter le jeton CSRF à l'URL de retour pour que le POST réussisse.
Si votre opérateur humain ferme son navigateur ou si vous utilisez une URL d'Éditeur intelligent hébergé non analysable, votre URL de retour ne sera pas appelée.
clippingMagicJson se décode en :
{
"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 se décode en :
{
"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"
} ]
}