Pour pouvoir utiliser l’API
- Ouvrez un compte
- vous trouvez votre clé (token) dans Mon Compte/Gérer mon compte/
Introduction
Ici, vous trouverez la documentation pour :
1 – Détourer vos images
2 – Télécharger vos images
3 – Obtenir des informations sur votre compte
Via le language / framework de votre choix, effectuez vos requêtes via l’url suivante :
https://www.detourage-immediat.com/api/[votre_endpoint]
Les requêtes renvoient généralement une réponse JSON.
Dans les exemples de cette documentation, nous utiliserons la commande curl.
Dans les exemples de cette documentation, nous utiliserons la commande curl.
Authentification
Chaque requête doit être accompagnée du header X-AUTH-TOKEN, dont la valeur correspond à votre clé API :
curl -H "X-AUTH-TOKEN: votre_token" https://www.detourage-immediat.com/api/[votre_endpoint]
Commandes
L’organisation de vos images se fait au sein de commandes. Il vous faudra ainsi en créer pour pouvoir détourer et télécharger une image.
Le sens de la manoeuvre est le suivant :
Le sens de la manoeuvre est le suivant :
1 – Créez ou récupérez une nouvelle commande
2 – Uploadez autant d’image que vous souhaitez
3 – Finalisez votre commande
Nouvelle commande
Créez une commande au sein de laquelle vous uploaderez vos images à détourer. Il ne vous est possible d’avoir qu’une nouvelle commande à la fois. Si une nouvelle commande existe déjà, cet endpoint vous renverra cette dernière.
Endpoint : GET
https://www.detourage-immediat.com/api/new
Réponse : JSON
{
id: 974,
createdAt: 2019-12-24
}
Exemple :
curl -H "X-AUTH-TOKEN: votre_token" https://www.detourage-immediat.com/api/new
Finaliser une commande
Une fois vos images détourées, finalisez votre commande pour la voir apparaître dans votre espace client. Une fois votre commande finalisée, il vous sera de nouveau possible de créer une nouvelle commande.
Endpoint : GET
https://www.detourage-immediat.com/api/finalize
Réponse : JSON
{
id: 974,
status: 3
}
Exemple :
curl -H "X-AUTH-TOKEN: votre_token" https://www.detourage-immediat.com/api/finalize
Détourer des images
Le détourage de vos images s’effectue en 2 temps :
1 – Uploadez vos images
2 – Téléchargez vos images
Uploader des images
Uploadez votre image, et notre système s’occupe de la détourer automatiquement.
Les images que vous uploadez seront associées à votre nouvelle commande. Si vous ne possédez pas de nouvelle commande, cet endpoint vous renverra une erreur.
Cet endpoint vous renvoie l’id de l’image détourée, que vous pouvez récupérer afin de la télécharger.
Les images que vous uploadez seront associées à votre nouvelle commande. Si vous ne possédez pas de nouvelle commande, cet endpoint vous renverra une erreur.
Cet endpoint vous renvoie l’id de l’image détourée, que vous pouvez récupérer afin de la télécharger.
Endpoint : POST
https://www.detourage-immediat.com/api/upload
Réponse : JSON
{
id: 679,
name: "mon_image.png",
commission: 974
}
Exemple :
curl -H "X-AUTH-TOKEN: votre_token" https://www.detourage-immediat.com/api/upload -F "file=@path_de_votre_image"
Télécharger des images
Pour télécharger une image, il vous suffit d’indiquer l’id de cette dernière.
Endpoint : GET
https://www.detourage-immediat.com/api/download/[id_de_votre_image]
Réponse : Image
Exemple :
curl -H "X-AUTH-TOKEN: votre_token" "https://www.detourage-immediat.com/api/download/id_de_votre_image" -o "image.png"
