Documentation API

L’API de la Toolbox SISTRIX 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.

À partir du forfait « Plus », l’API fait partie de votre compte Toolbox. Les données disponibles dépendent du forfait choisi. La formule « Plus » vous donne un niveau d’accès limité à l’API, qui comprend uniquement les données de l’Indice de Visibilité. Les formules « Professional » et « Premium » vous offrent un accès complet à toutes les données et fonctionnalités.

Les différentes méthodes API sont énumérées ailleurs sur cette page. Sur cette page, vous trouverez des informations générales sur notre API.

Les données, fonctionnalités et résultats disponibles ne peuvent être transmis à des tiers sans autorisation écrite spécifique.

Référence de l’API :

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.

Authentification de l’API

L’authentification se fait par l’utilisation d’une clé API. Le compte utilisateur principal peut demander une clé API sur cette page.

La clé API doit être transmise avec le paramètre « api_key » à chaque requête. Si cela ne se produit pas ou si une clé API invalide est utilisée, l’API rapporte le message d’erreur « 100 ». Vous pouvez créer de multiples clés API dans la Toolbox, leur appliquer un label et les supprimer si vous le souhaitez. Vous trouverez également un logfile montrant les appels API les plus récents effectués avec vos clés.

Système de crédit

Les crédits sont débités de votre compte en fonction des données demandées. Les coûts respectifs des crédits sont indiqués à côté des descriptions. Les crédits de votre compte se rechargent pendant la nuit, du dimanche au lundi. Pour chaque module Toolbox souscrit, le compte est crédité de 10 000 crédits. Les crédits ne sont pas reconduits de la semaine précédente.

Vous pouvez consulter le montant des crédits restants via l’API :

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

Format de sortie

Toutes les valeurs de demande et de réponse sont encodées en UTF-8. Normalement, les réponses de l’interface API sont au format XML. Il est également possible de recevoir des données au format JSON. Pour cela, le paramètre « format » doit être ajouté à chaque URL, avec 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 ».

Valeurs possibles pour le paramètre « country » : de, at, ch, it, es, fr, pl, nl, uk, us, se, br, tr, be, ie, pt, dk, no, fi, gr, hu, sk, cz, au, jp, ca, ro, hr, bg, si

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

Base de données étendue

Les requêtes API se font, par défaut, sur la base de données standard de la Toolbox. Elles comprennent deux millions de mots-clés par pays – un million pour les résultats sur ordinateur de bureau et un million pour les données sur mobile. De plus, nous proposons une base de données étendue avec des millions de mots-clés supplémentaires dans certains pays. Ces mots-clés sont mis à jour mensuellement plutôt qu’hebdomadairement, mais sont beaucoup plus complets. Afin d’accéder à la base de données étendue via l’API, le paramètre « extended » doit être défini sur la valeur « true ».

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

Données relatives aux smartphones

Outre les résultats des recherches effectuées sur ordinateur de bureau, la Toolbox calcule également les résultats des recherches effectuées sur téléphone mobile. Afin de récupérer ces résultats via l’API, le paramètre « mobile »  doit être défini sur la valeur « true ». La base de données étendue n’est pas disponible pour les données des mobiles, par conséquent une combinaison avec « extended » n’est pas possible.

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

Limite de débit

L’API limite l’accès à 300 demandes par minute, par clé API. Veuillez vous assurer qu’il y a un délai d’au moins 300 ms entre chaque demande. Si vous dépassez ces limites, l’API retournera le code de statut 429 (Too many requests), les crédits pour ces demandes ne seront pas déduits.

08.06.2022