La Mini API a pour but de fournir les données de position et de pagerank en lecture pour une journée précise. Les données sont transmises sur une demande venant d'un formulaire (méthode POST) via un flux XML encodé en ISO-8859-1. Elle permet ainsi d'intégrer facilement des données venant de notre base dans un intranet par exemple. Une clé est nécessaire pour faire fonctionner l'API. Cette clé est disponible dans la page Mon Compte. L'API est réservée aux utilisateurs ayant souscris une offre Agence Web.

La demande se fait par un appel en POST vers l'URL http://www.ranks.fr/mini_api . 2 arguments sont attendus à savoir key et date (au format AAAA-MM-JJ).
Voici un exemple d'intégration via un formulaire HTML :

<form method="post" action="http://www.ranks.fr/mini_api">
<label>key : </label><input type="text" name="key" />
<label>date : </label><input type="text" name="date" value="2008-07-01" />
<input type="submit" value="ok" />
</form>

ranks	balise racine
login	votre login ranks.fr
date	date pour la journée demandée
urls	toutes les URLs ayant des valeurs pour la journée demandée
url	une url spécifique   paramètre :     value => URL suivie
keywords	tous les mots clés pour l'URL séléctionnée ayant des valeurs pour la journée demandée
keyword	un mot clé spécifique   paramètres :     value => mot clé suivi     lang => code de langue Google     nbresults => nombre de résultat
foundurls	toutes les URLs trouvées ayant des valeurs pour la journée demandée
foundurl	URL trouvée parmis le résultats Google pour la journée demandée   paramètre :     value => URL trouvée
position	position pour l'URL trouvée
pagerank	pagerank pour l'URL trouvée
nbresults	Nombre de résultats trouvé par Google

Voici un exemple du fichier XML de retour :

<?xml version="1.0" encoding="ISO-8859-1"?>
<ranks>
  <login>xav_</login>
  <date value="2008-07-01">
  <urls>
    <url value="www.votresuivi1.com*">
      <keywords>
        <keyword value="motcle1" lang="fr" nbresults="250000">
          <foundurls>
          <foundurl value="http://www.votresuivi1.com/">
            <position>1</position>
            <pagerank>2</pagerank>
          </foundurl>
          <foundurl value="http://www.votresuivi1.com/une-autre-page.html">
            <position>18</position>
            <pagerank>2</pagerank>
          </foundurl>
          </foundurls>
        </keyword>
        <keyword value="motcle1" lang="en" nbresults="250000">
          <foundurls>
          <foundurl value="http://www.votresuivi1.com/">
            <position>20</position>
            <pagerank>2</pagerank>
          </foundurl>
          </foundurls>
        </keyword>
        <keyword value="motcle2" lang="fr" nbresults="150000">
          <foundurls>
          <foundurl value="http://www.votresuivi1.com/encore-une-autre-page.html">
            <position>90</position>
            <pagerank>2</pagerank>
          </foundurl>
          </foundurls>
        </keyword>
      </keywords>
    </url>
    <url value="www.votresuivi2.fr*">
      <keywords>
        <keyword value="motcle" lang="fr" nbresults="290000">
          <foundurls>
          <foundurl value="http://www.votresuivi2.fr/">
            <position>13</position>
            <pagerank>4</pagerank>
          </foundurl>
          </foundurls>
        </keyword>
      </keywords>
    </url>
    </urls>
  </date>
</ranks>

L'export XML a pour but de fournir les données de position et de pagerank sous forme d'un fichier structuré à l'aide de balises. Il est ensuite facile (moyennant un peu de programmation) d'intégrer vos données dans un système gérant des données XML.
L'API est réservée aux utilisateurs professionnels ayant souscris soit une offre Référenceur Pro, soit une offre Agence Web.

ranks	balise racine
urls	ensemble des URLs
url	une url spécifique   paramètre :     value => URL suivie
keywords	tous les mots clés pour l'URL séléctionnée
keyword	un mot clé spécifique   paramètres :     value => mot clé suivi     lang => code de langue Google
foundurls	toutes les URLs trouvées ayant des valeurs
foundurl	URL trouvée parmis le résultats Google   paramètre :     value => URL trouvée
date	date et heure d'extraction des positions (format AAAA-MM-JJ HH:MM:SS)
position	position pour l'URL trouvée
pagerank	pagerank pour l'URL trouvée

Voici un exemple du fichier XML généré :

<?xml version="1.0" encoding="ISO-8859-1"?>
<ranks>
  <urls>
    <url value="www.votresuivi1.com*">
      <keywords>
        <keyword value="motcle1" lang="fr">
          <foundurls>
          <foundurl value="http://www.votresuivi1.com/">
            <position>1</position>
            <pagerank>2</pagerank>
          </foundurl>
          <foundurl value="http://www.votresuivi1.com/une-autre-page.html">
            <position>18</position>
            <pagerank>2</pagerank>
          </foundurl>
          </foundurls>
        </keyword>
        <keyword value="motcle1" lang="en">
          <foundurls>
          <foundurl value="http://www.votresuivi1.com/">
            <position>20</position>
            <pagerank>2</pagerank>
          </foundurl>
          </foundurls>
        </keyword>
        <keyword value="motcle2" lang="fr">
          <foundurls>
          <foundurl value="http://www.votresuivi1.com/encore-une-autre-page.html">
            <position>90</position>
            <pagerank>2</pagerank>
          </foundurl>
          </foundurls>
        </keyword>
      </keywords>
    </url>
    <url value="www.votresuivi2.fr">
      <keywords>
        <keyword value="motcle" lang="fr">
          <foundurls>
          <foundurl value="http://www.votresuivi2.fr/">
            <position>13</position>
            <pagerank>4</pagerank>
          </foundurl>
          </foundurls>
        </keyword>
      </keywords>
    </url>
    </urls>
</ranks>