Documentation

Images et classifications

L'utilisation de l'API est conditionnée par la présence d'une clé API pour l'authentification. Ce service est inutilisable sans moyen d'authentification même si vous l'utilisez en mode d'essai. Pour cela, vous devez vous inscrire et souscrire au plan gratuit afin d'obtenir une clé API valide pour commencer à utiliser le service. Aucun des services et terminaux de l'API n'est disponible sans authentification.

Le point de terminaison principal de l'API est image-classification API. Vous pouvez utiliser ce point final pour demander la classification de vos images. Ce point final doit être appelé avec les balises comme élément du chemin. La valeur doit être un nombre entier entre 1 et 5 et correspond au nombre d'étiquettes que vous souhaitez obtenir de votre image. Vous devez spécifier ce nombre d'étiquettes dans le chemin juste après le point final et non comme un paramètre.

Ce point de terminaison doit être appelé en joignant dans la requête le fichier image avec la clé image_file et le fichier image comme valeur et votre clé API avec la clé Authorization et Token <clé d'API> comme valeur. Vous pouvez également spécifier une langue pour les étiquettes que vous souhaitez obtenir entre l'Anglais et le Français en utilisant la clé de langue et en ajoutant respectivement en et fr comme valeur. Si le label n'est pas disponible dans la langue que vous avez demandée, le paramètre lang sera ignoré et le label sera renvoyé dans la langue disponible par défaut. La réponse que vous obtiendrez aura la forme ci-contre.

GET /api/v1/profile

Vous pouvez également utiliser l'API pour obtenir des informations sur votre profil en utilisant le point de terminaison appelé profile API. Ce point de terminaison ne prend aucun paramètre ou élément supplémentaire. Il vous suffit de joindre votre clé API avec la clé Authorization et Token <clé d'api> comme valeur dans votre requête. L'appel de ce terminal par la méthode GET renvoie un objet json avec les données de votre profil comme présenté ci-contre.

L'appel de ce terminal par la méthode PUT vous permet d'apporter quelques modifications aux données de votre profil. Vous pouvez ajouter un ou plusieurs paramètres parmi first_name, last_name, civility, status, company, siret, address, address_complement, postal_code, city, phone ou mobile_phone dans votre requête. Tous les paramètres que vous ajoutez dans votre demande seront modifiés et vous obtiendrez l'objet json correspondant à votre profil mis à jour avec la forme telle que présentée ci-contre.

GET /api/v1/images

GET /api/v1/images/?q=7173095073798789242

L'API vous permet également de télécharger des images sur votre compte sans le classer. Vous pourrez en obtenir des labels plus tard. Pour cela, vous pouvez appeler le terminal appelé images API. Il vous suffit d'appeler l'API avec la méthode POST et de joindre le fichier avec la clé image_file et le fichier image comme valeur et votre clé API pour l'authentification avec la clé Authorization et Token <clé d'api> comme valeur.

Si vous avez déjà téléchargé plusieurs images, vous pouvez également obtenir les données de l'image et le lien direct vers une ou plusieurs images appelant le point final avec la méthode GET. Sans aucun paramètre, la réponse contiendra toutes les images que vous avez téléchargées et associées à votre compte. Pour obtenir une image spécifique, vous pouvez ajouter le paramètre q à votre demande en spécifiant la référence ou le lien vers l'image comme dans l'exemple ci-dessus. Vous pouvez également obtenir une ou plusieurs images en spécifiant une partie seulement de la référence ou du chemin dans ce même paramètre afin de le faire fonctionner comme une requête de recherche partielle. Dans les deux cas, l'objet json que vous obtiendrez en réponse se présentera comme ci-contre.

GET /api/v1/classifications

Lorsque vous avez déjà envoyé des images pour obtenir les classifications, vous pouvez également obtenir les classifications précédentes en utilisant l'API Images Vision en appelant le point de terminaison classifications API avec la méthode GET. Si vous appelez le point de terminaison sans aucun paramètre, vous obtiendrez toutes vos classifications dans l'objet de réponse json. Vous pouvez ajouter le paramètre q pour rechercher une classification spécifique en spécifiant la référence exacte ou une partie de celle-ci comme dans l'exemple ci-dessus. Vous devez appeler ce point de terminaison avec la clé Authorization associée à votre clé API pour l'authentification avec cette forme spécifique Token < clé d'api> comme valeur. La réponse que vous obtiendrez sera un ou plusieurs objet(s) Classification qui ressemblent à celui présenté ci-contre.

Abonnements

GET /api/v1/subscriptions

Vous pouvez également utiliser l'API pour obtenir des informations sur vos abonnements en cours et résiliés comme vous pouvez le faire en naviguant dans votre espace client avec l'interface graphique. Pour obtenir vos abonnements en cours ou annulés, vous devez appeler le point de terminaison subscriptions API avec la méthode GET. Si vous l'appelez sans aucun paramètre, vous obtiendrez tous les abonnements associés à votre compte, qu'ils soient actifs ou annulés. Comme indiqué ci-dessus, vous pouvez utiliser le paramètre q pour y effectuer une recherche afin de les trier par nom ou par périodicité. Les abonnements n'ont pas de référence, vous ne pouvez donc pas rechercher un abonnement en particulier en utilisant un identifiant unique. Vous devez appeler ce point de terminaison en joignant votre clé API avec ce format Token <api key> comme valeur l'associant à la clé Authorization pour votre authentification. Le ou les objet(s) json que vous obtiendrez en réponse de ce point de terminaison ressembleront individuellement à celui présenté ci-contre.

GET /api/v1/contributions

Vous pouvez également utiliser les données API de Images Vision pour vos factures en appelant le point de terminaison contributions API avec la méthode GET comme vous pouvez le faire en naviguant dans votre espace client via l'interface graphique. Pour obtenir toutes les contributions qui sont enregistrées et associées à votre compte et à vos abonnements actifs et/ou précédents, vous pouvez appeler ce point de terminaison sans aucun paramètre. Si vous souhaitez obtenir une facture particulière, vous pouvez spécifier la référence exacte ou une partie de celle-ci en utilisant le paramètre q dans votre demande. Ce paramètre accepte également le nom d'un abonnement pour obtenir toutes les factures qui y sont liées. Tous les appels effectués sur ce point de terminaison doivent être associés à la clé Authorization avec votre clé API valide comme valeur transmise sous la forme suivante Token <clé d'api>. Le ou les objets json que vous obtiendrez en réponse de ce point de terminaison auront la forme de celui présenté ci-contre.