NAV
php bash

Utilisation de l'API

Bienvenue sur l'API Patate.fr

Ce guide d'utilisation décrit les différentes méthodes accessibles via l'API.

L'API a été conçue pour faciliter l'accès à notre base de plusieurs milliards de résultats sur les liens issus des sites Français (tous positionnés sur Google.fr).

Fonctionnement de l'API

L'utilisation de l'API est pour le moment restreint aux personnes qui en font la demande à contact@ranxplorer.com en justifiant de l'utilisation. Pour accéder à l'API, nous vous fournirons alors un token API.

Coût d'utilisation de l'API

Exemple de réponse:

{
    "errors": false,
    "statusCode": 200,
    "metas": {
        "remainingCredits": 1235,
        "results": 152,
        "host": "www.ranks.fr",
        "timeSeconds": 0.86
    },
    "data": [
        {
            "host": "www.journaldunet.com",
            "patateScore": 94
        },
  {...},
  {...}
  ]
}

Chaque requête adressée à l'API est facturée sur la base d'un montant de 1 ou 2 crédits selon la requête effectuée.

Par ailleurs, chaque réponse renvoyée par l'API contient un élément méta qui récapitule:

HOSTS

Stats globales

Récupérez une synthèse de linking soit pour un nom de domaine , soit pour un host (=sous-domaine), avec notamment comme information :

Chaque requête de ce type coute 1 crédit.

Exemple de requête:

$url='https://api.patate.fr/v1/?type=global&search=www.ranks.fr';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
        'Accept: application/json',
        'X-Patate-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
);
$result = curl_exec($ch);
return json_decode($result, true);
curl -G "https://api.patate.fr/v1/" \
-H "Accept: application/json" \
-H "X-Patate-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
    -d "type"="global" \
    -d "search"="www.ranks.fr" \

Exemple de réponse:

{
    "errors": false,
    "statusCode": 200,
    "data": [
        {
            "host": "www.ranks.fr",
            "patateScore": 38,
            "refDomains": 139,
            "refDomainsDoFollow": 119,
            "refIps": 131,
            "refFootPrints": 100,
            "spam": false,
            "pbn": false
        },
        {
            "host": "demo.ranks.fr",
            "patateScore": 10,
            "refDomains": 8,
            "refDomainsDoFollow": 6,
            "refIps": 8,
            "refFootPrints": 8,
            "spam": false,
            "pbn": false
        },
        {
            "host": "ranks.fr",
            "patateScore": 9,
            "refDomains": 6,
            "refDomainsDoFollow": 5,
            "refIps": 6,
            "refFootPrints": 5,
            "spam": false,
            "pbn": false
        },
        {
            "host": "m.ranks.fr",
            "patateScore": 3,
            "refDomains": 1,
            "refDomainsDoFollow": 1,
            "refIps": 1,
            "refFootPrints": 1,
            "spam": false,
            "pbn": false
        }
    ],
    "metas": {
        "remainingCredits": "99970",
        "results": 4,
        "Search": "ranks.fr",
        "timeSeconds": 0.03
    }
}

HTTP Request

GET v1/?type=global

Paramètres

Paramètre Type Status Description
search string requis Renseignez ici soit un Nom de domaine, soit un Host. Longeur maximum: 200 caractères

Réponse

Champ Description
Host Host trouvé
patateScore Valeur du PatateScore du host, compris entre 0 et 100
refDomains Nombre de domaines référents faisant un lien vers le host
refDomainsDoFollow Nombre de domaines référents faisant un lien en DoFollow vers le host
refIps Nombre d'IPs référentes parmi les hosts référents, faisant un lien vers le host
refFootPrints Nombre d'empreintes trouvées parmi les domaines référents faisant un lien vers le host. Une empreinte correspond à des sites sur un même hébergeur et avec des configurations DNS identiques.
spam Est-ce que le host est susceptible d'être spammé ? (backlinks sur des pages de mauvaise qualité)
pbn Est-ce que le host est susceptible d'être à l'intérieur d'un réseau de site privé ? (backlinks potentiellement non naturels)

Hosts référents

Récupérez la liste des 50 premiers Hosts (un host= un sous-domaine) qui font au moins un lien, classés par PatateScore décroissant. (les sites de qualité en premier)

Chaque requête de ce type coute 2 crédits.

Exemple de requête:

$url='https://api.patate.fr/v1/?type=refdoms&host=www.ranks.fr';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
        'Accept: application/json',
        'X-Patate-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
);
$result = curl_exec($ch);
return json_decode($result, true);
curl -G "https://api.patate.fr/v1/" \
-H "Accept: application/json" \
-H "X-Patate-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
    -d "type"="refdoms" \
    -d "search"="www.ranks.fr" \

Exemple de réponse:

{
    "errors": false,
    "statusCode": 200,
    "data": [
        {
            "host": "www.journaldunet.com",
            "backlinks": 4,
            "patateScore": 94,
            "refDomains": 8091,
            "spam": 0,
            "pbn": 0,
            "footprint": 37948
        },
        {
            "host": "www.blogdumoderateur.com",
            "backlinks": 4,
            "patateScore": 90,
            "refDomains": 3051,
            "spam": 0,
            "pbn": 0,
            "footprint": 46148
        },
        {
            "host": "www.webrankinfo.com",
            "backlinks": 6,
            "patateScore": 87,
            "refDomains": 4441,
            "spam": 0,
            "pbn": 0,
            "footprint": 49474
        },
        {
            "host": "www.abondance.com",
            "backlinks": 4,
            "patateScore": 79,
            "refDomains": 1011,
            "spam": 0,
            "pbn": 0,
            "footprint": 25329
        },
        {
            "host": "fr.wix.com",
            "backlinks": 1,
            "patateScore": 74,
            "refDomains": 3698,
            "spam": 0,
            "pbn": 0,
            "footprint": 18790
        },
        {
            "host": "www.frenchweb.fr",
            "backlinks": 3,
            "patateScore": 74,
            "refDomains": 2011,
            "spam": 0,
            "pbn": 0,
            "footprint": 54216
        },,

HTTP Request

GET v1/?type=refdoms

Paramètres

Paramètre Type Status Description
host string requis Host sur lesquel vous souhaitez faire la recherche

Réponse

Champ Description
host Host qui link le site recherché
backlinks Nombre de backlinks en provenance du host
patateScore PatateScore du host
refDomains Nom de domaines référents pour le host référent
spam Est-ce que le host référent est susceptible d'être spammé ?
pbn Est-ce que le host référent est susceptible d'être à l'intérieur d'un réseau de site privé ?
footprint Empreinte du host référent (identifiant numérique) : 2 hosts référents ayant le même identifiant sont susceptibles d'être des sites d'un même réseau de sites.

URLs

Backlinks référents

Récupérez la liste des 30 premiers liens retours de qualité (=indexés et positionnés sur Google), en provenance d'un host et pointant vers un autre host cible.

Chaque requête de ce type coute 2 crédits.

Exemple de requête:

$url='https://api.patate.fr/v1/?type=backlinks&hostfrom=www.webrankinfo.com&hostto=www.ranks.fr';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
        'Accept: application/json',
        'X-Patate-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
);
$result = curl_exec($ch);
return json_decode($result, true);
curl -G "https://api.patate.fr/v1/" \
-H "Accept: application/json" \
-H "X-Patate-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
    -d "type"="backlinks" \
    -d "hostfrom"="www.webrankinfo.com" \
    -d "hostto"="www.ranks.fr" \

Exemple de réponse:

{
    "errors": false,
    "statusCode": 200,
    "metas": {
        "remainingCredits": 1235,
        "results": 6,
        "host": {
            "from": "www.webrankinfo.com",
            "to": "www.ranks.fr"
        },
        "timeSeconds": 1.09
    },
    "data": [
        {
            "url": {
                "from": "https:\/\/www.webrankinfo.com\/forum\/t\/site-non-penalise-mais-visibilite-incoherente.156076\/",
                "to": "http:\/\/www.ranks.fr\/fr\/outil-google-sandbox"
            },
            "anchor": "http:\/\/www.ranks.fr\/fr\/outil-google-sandbox",
            "noFollow": true,
            "type": 1,
            "numberKeywords": 1,
            "trafic": 2,
            "lastCrawled": "2021-02-19"
        },
        {
            "url": {
                "from": "https:\/\/www.webrankinfo.com\/forum\/t\/positeo-en-panne.162138\/",
                "to": "http:\/\/www.ranks.fr\/"
            },
            "anchor": "http:\/\/www.ranks.fr\/",
            "noFollow": true,
            "type": 1,
            "numberKeywords": 1,
            "trafic": 2,
            "lastCrawled": "2021-02-19"
        },
        {
            "url": {
                "from": "https:\/\/www.webrankinfo.com\/forum\/t\/montee-subite-de-sites-pages-jaunes.171901\/",
                "to": "http:\/\/www.ranks.fr\/fr\/notprovided\/top1000"
            },
            "anchor": "http:\/\/www.ranks.fr\/fr\/notprovided\/top1000",
            "noFollow": true,
            "type": 1,
            "numberKeywords": 4,
            "trafic": 5,
            "lastCrawled": "2021-02-18"
        },
        {
            "url": {
                "from": "https:\/\/www.webrankinfo.com\/forum\/t\/ma-position-sur-google-fr-en-francais-change-selon-la-localisation-de-la-demande.164914\/",
                "to": "http:\/\/www.ranks.fr\/"
            },
            "anchor": "http:\/\/www.ranks.fr\/",
            "noFollow": true,
            "type": 1,
            "numberKeywords": 1,
            "trafic": 3,
            "lastCrawled": "2021-02-19"
        },

HTTP Request

GET v1/?type=backlinks

Paramètres

Paramètre Type Status Description
hostto string requis Host cible vers lesquels les liens pointent. Longueur maximum: 200 caractères
hostfrom string optionnel Host référent depuis lequel vous souhaitez connnaitre les liens. Longueur maximum: 200 caractères

Réponse

Champ Description
from URL de provenance qui fait un lien depuis le Host référent
to URL cible vers le host cible
anchor Ancre du lien (texte ou balise alt si image)
noFollow Est-ce que le lien est nofollow ou pas (true ou false)
numberKeywords Nombre de mots-clés sur lesquels l'url de provenance est positionnée dans la base Ranxplorer au moment du crawl
trafic Trafic SEO mensuel Ranxplorer estimé pour l'url de provenance au moment du crawl
lastCrawled Date du crawl de la page par le robot Patate.fr

Code Erreurs

Liste des StatusCode renvoyés en cas d'erreur et des messages liés

Exemple d'erreur

{
    "errors": true,
    "statusCode": 403,
    "message": "Mauvaise clé API"
}
Code réponse Message  Détail
403 Mauvaise clé API Votre token d'identification n'est pas reconnu comme valable
403 Aucune clé API spécifiée Vous n'avez pas renseigné le token d'identification
403 Vous n'avez plus assez de crédits API, merci de nous contacter Votre crédit API n'est pas suffisant pour effectuer cette requête
403 Vous avez effectué trop de requêtes Vous avez dépassé le rate limit autorisé pour notre API (10 requêtes en 30 secondes max)
500  Echec de connexion à la base de données  Erreur de connexion à notre base de données
500  Mauvaise valeur pour le paramètre TYPE  Vous n'avez pas spéficié la valeur de type= (méthode utilisée pour la requete API)
501  Le paramètre SEARCH n'a pas été spécifié  Vous n'avez pas spécifié de recherche
502  Le paramètre SEARCH ne correspond pas à un nom de domaine  Mauvais formattage du nom de domaine
503  Merci de saisir un nom de domaine ou un sous-domaine  Vous n'avez pas saisi un nom de domaine ou de host correct
510  Le paramètre HOST n'a pas été renseigné  Vous n'avez pas spécifié de host
511  Le paramètre HOST est incorrect  La valeur du host est incorrecte
521  Mauvaise valeur pour le paramêtre HOSTFROM  La valeur du hostfrom est incorrecte
522  Le paramêtre HOSTTO n'a pas été spécifié  Vous n'avez pas spécifié de hostto
523  Mauvaise valeur pour le paramêtre HOSTTO  La valeur du hostto est incorrecte