API keywords - documentation

Cette API permet de générer des mots-clés comme le fait notre générateur de mots-clés SEO. Elle répond sous la forme d’un fichier JSON que vous pouvez facilement reprendre dans vos scripts et applications.

L’accès à cette API nécessite de souscrire à l’une des offres permettant de l’utiliser. Testez gratuitement son fonctionnement avec notre offre de test.

Obtenir une liste de mots-clés

Les requêtes se font en HTTPS sur ce endpoint :

https://api.alyze.com/keywords/v1

Pour obtenir la liste des mots-clés, il est nécessaire de passer quelques paramètres HTTP comme ceci : 

https://api.alyze.com/keywords/v1?user=xxx&api_password=xxx&keyword=xxx

• user=xxx et api_password=xxx fournissent le nom d’utilisateur et le mot de passe de l’API comme cela se passe pour l’API d’analyse de pages. Le nom d’utilisateur est généralement l’adresse email que vous avez utilisée pour vous inscrire sur Alyze et le mot de passe est spécifique à l’API. Vous l’avez reçu lors de votre inscription.
• keyword=xxx : il s’agit du mot, de l’expression ou même de la phrase que vous voulez soumettre au générateur de mots-clés.

Paramètres optionnels :

• context=xxx : où vous pouvez fournir une courte chaîne de texte pour désambigüiser certaines expressions. Par exemple, si votre mot-clé est « avocat », vous pouvez fournir « bourse d’études » ou « juriste » dans le paramètre context pour indiquer le contexte où vous voulez employer l’expression.
• lang=xxx : par ce paramètre, il est possible de changer la langue de référence pour obtenir des expressions adaptées à la langue cible. Les valeurs possibles sont : fr, en, es et it (fr par défaut). 

Explorer la liste des mots-clés

L’API de génération de mot-clé répond en quelques secondes. Une fois ce délai passé, un fichier JSON est renvoyé. Voici ses principales propriétés.

• aiUsages : l’API keywords consomme des crédits IA, suivez dans cette propriété vos usages. Retrouvez également cette information dans votre espace membre.
• status : contient « done » si tout s’est bien passé, un code d’erreur sinon.
• response : un objet contenant des propriétés avec les mots-clés et expressions générés : 
  • searchType : le type de recherche que l’expression fournie suggère : informationalSearch, navigationalSearch, transactionalSearch, localSearch, comparativeSearch ou newsSearch.
  • contextsList : si plusieurs contextes pour l’expression fournie ont été identifiés, contient un tableau avec la liste de ces contextes.
  • selectedContext : si plusieurs contextes pour l’expression fournie ont été identifiés, celui qui a été sélectionné.
  • synonymous : contient un tableau avec les mots-clés synonymes de l’expression fournie.
  • derived : les mots-clés dérivés (formes plurielles, adjectifs ou noms dérivés, etc.).
  • related : des mots-clés très souvent rencontrés avec l’expression principale.
  • longTail : les expressions de longue traîne susceptible de générer un trafic qualifié.
  • lexicalField : une liste d’expressions du même champ lexical.
  • intent : des mots-clés ou expression directement en lien avec l’intention de recherche identifiée.
  • questions : une liste de questions liée et potentiellement intéressante pour le SEO.