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 à [email protected] 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 25 ou 50 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:

• la recherche effectuée (search)
• le nombre de résultats renvoyés (results)
• le nombre de crédits disponibles sur votre solde (remainingCredits)

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 :

• le PatateScore : score de linking compris entre 0 et 100 qui qualifie la puissance SEO de chaque host
• le nombre de Domaines référents
• si le domaine, malgré sa puissance SEO, est susceptible d'avoir des liens de mauvaise qualité (site potentiellement spammé)

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

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

Réponse

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 50 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

Réponse

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 50 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

Réponse

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"
}