getHrefs

Gibt alle Ziel-URLs der Backlinks einer Domain zurück. Das Linkziel wird mit Get-Parameter und Anker ausgegeben. Siehe hierzu: getLinkedPages

Route /links/getHrefs[/:key[/:domain[/:format[/:limit[/:skip]]]]]
Erforderliche Parameter domain
Optionale Parameter format
limit (max:1000)
skip
Rückgabewerte href
Querschnittverbindungen
Hinweis Limit: Das maximale Limit ist 1000. Um mehr Ergebnisse zu erhalten, benutzen Sie den Parameter Skip.
resultCount: Enthält die Anzahl des Ergebnisses ohne Filter. Wird z.B. bei der Paginierung benötigt.

Parameter

Bezeichnung beschreibung Wertebereich Standardwert
domain Enthält einen qualifizierten Domainnamen. (www.)?(A-Z|a-z|0-9)+. (a-z)+
limit Legt fest, wie viele Ergebniszeilen zurückgegeben werden sollen. (max:1000) 0-1000 100
skip Legt fest, wie viele Seiten des Ergebnisarrays übersprungen werden sollen. Eine Seite entspricht dem Wert von limit. (0-9)+ 0
format Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll. json|xml json

Rückgabewerte

BEZEICHNUNG BESCHREIBUNG WERTEBEREICH
hrefs URLs der verlinkten Webseiten inkl. Parameter string

Meldungen

Nachricht Beschreibung
maximum limit exeeded Das maximale Limit wurde überschritten.
no permission Der Schlüssel hat keinen Zugriff auf diese Funktion.
internal error Ein interner Fehler ist aufgetreten.
param missing Ein erforderlicher Parameter wurde nicht übergeben.
param invalid Der Wert eines übergebenen Parameters ist nicht gültig.
result empty Die Bearbeitung der Anfrage war erfolgreich, aber das Ergebnis ist leer.
cost error Der aktuelle Kreditumfang reicht nicht aus, um die Anfrage zu bearbeiten.
0k. Die Bearbeitung der Anfrage war erfolgreich.

Beispielcode

$root = 'https://suite.xovi.net/api/'; 
$arrayParams = array(  
    'service' =>'links',
    'method' =>'getHrefs',
    'key' =>'myPersonalKey',
    'domain' =>'www.xovi.de',
    'format' => 'xml'
 );
$GETparams = implode('/', $arrayParams);

$requestURL = $root.$GETparams;

if (!function_exists('curl_init')) die('cURL not available');

$ch = curl_init();
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_URL, $requestURL);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Download the given URL, and return output
$output = curl_exec($ch);

// Close the cURL resource, and free system resources
curl_close($ch);

echo $output;

Beispielergebnisse

JSON

{
 "apiErrorCode":"0",
 "apiErrorMessage":"0k.",
 "apiResult":[
     {"href":"http:\/\/www.xovi.de"},
     {"href":"http:\/\/www.xovi.de#content"}
    ]
}

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <hrefs>
            <href><href>http://www.xovi.de</href></href>
            <href><href>http://www.xovi.de#content</href></href>
        </hrefs>
    </apiResult>
</result>