Référence de l’API

L’ API SISTRIX Toolbox permet d’accéder à la majorité des données de la Toolbox de façon automatique ou sur les appareils appropriés. Cela vous permettra d’intégrer la Toolbox facilement à vos processus et outils internes.

L’API fait partie de votre compte Toolbox et par conséquent vous n’aurez pas besoin d’un forfait spécial ou d’options supplémentaires. Les données disponibles correspondent aux modules réservés de la Toolbox.

Les données Toolbox peuvent être accessibles via
le domaine , le mot-clé , le lien et les méthodes d’optimizer .
Ces méthodes sont consignées sur des pages distinctes. De même, il y a une page pour les codes de retour de l’API et les messages d’erreurs.

Connexion à Microsoft Excel & Tableaux Google

Bien que l’API de SISTRIX ait été initialement conçue pour utiliser les langages de programmation et de script, elle peut également être utilisée avec les tableaux Microsoft Excel et Google.
Nous analyseront comment se connecter à ces deux options dans deux articles distincts.

Authentification de l’API

L’authentification se fait grâce à la transmission d’une clé d’API. Vous pouvez demander votre clé d’API sur la page suivante, celle-ci sera normalement disponible dans un court délai :

https://fr.sistrix.com/account/api

La clé de l’API est acheminée à chaque requête grâce au paramètre « api_key ». Si cela ne se produit pas ou si vous avez utilisé une clé d’API incorrecte, l’API signale le message d’erreur suivant : « 100 ». Afin de recevoir une nouvelle clé d’API, veuillez contacter notre service client et celui-ci procédera rapidement au remplacement de votre clé d’API.

Système de crédit

Les crédits sont débités de votre compte en fonction des données que vous avez demandées. Les coûts de crédit respectifs sont énumérés avec les descriptions. Les crédits de votre compte se rechargent pendant la nuit, de dimanche à lundi. Pour chaque module de Toolbox auquel vous avez souscrit, le compte sera crédité de 10 000 crédits.

Les crédits de la semaine précédente ne sont pas reconductibles. Si les 5 modules de la Toolbox sont réservés et que vous avez besoin d’autres crédits d’API, des arrangements personnalisés peuvent être mis en place. Pour ce faire, veuillez contacter notre service client pour la Toolbox. Le montant des crédits restants peut être obtenu via l’API :

https://api.sistrix.com/credits?api_key=$key

Format de sortie

Toutes les valeurs de demandes et de réponse sont encodées en caractères UTF-8. Habituellement, les réponses de l’interface API sont affichées en format XML. Vous pouvez aussi recevoir des données au format JSON. Pour cela, vous devez ajouter le paramètre « format » à chaque URL ainsi que la valeur « json ».

https://api.sistrix.com/...?format=json

Choix du pays

Si aucun pays n’est choisi de manière explicite, toutes les valeurs de retour renvoient aux données de la Toolbox en Allemagne. D’autres pays peuvent être sélectionnés via la transmission des paramètres « country ».

Les valeurs possibles pour le paramètre « country » sont : de, at, ch, it, es, fr, pl, nl, uk, us, se, br, tr

https://api.sistrix.com/...?country=$country

Base de données élargie

Les demandes de l’API se font, par défaut, sur la base de données standard de la Toolbox. Celles-ci comprennent deux millions de mots-clés par pays – respectivement un million pour les résultats pour le bureau et un million pour les données du smartphone. De plus, nous offrons une base de données élargie contenant des millions de mots-clés supplémentaires pour certains pays. Ces mots-clés sont mis à jour sur une base mensuelle et non hebdomadaire, mais sont beaucoup plus complètes. Afin d’atteindre la base de données élargie via l’API, le paramètre « extended » doit être configuré sur la valeur « true ».

https://api.sistrix.com/...?extended=true

Données de smartphone

En plus des résultats de la recherche pour le bureau, la Toolbox calcule également les résultats de recherches effectuées avec les smartphones. Afin de récupérer ces résultats via l’API, le paramètre « mobile » doit être configuré sur la valeur « true ».

https://api.sistrix.com/...?mobile=true