getLinktexts

Gibt alle Ankertexte der Backlinks zu einer Domain zurück.

Route	/links/getLinktexts[/:key[/:domain[/:format[/:limit[/:skip]]]]]
Erforderliche Parameter	domain
Optionale Parameter	limit (max:1000) skip format
Rückgabewerte	text
Querschnittverbindungen	–
Hinweise	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
linktexts	Ein numerisches Array mit den Linktexten der Backlinks	Je nach format kodiertes numerisches Array mit Strings

Meldungen

Nachricht	Beschreibung
maximum limit exeeded	Das maximale Limit wurde überschritten.
no access	Der Schlüssel hat keinen Zugriff auf die 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'  => 'getLinktexts',
    '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":[
        {"text":"Xovi"},
        {"text":"↪ zurWebsite"}
    ]
}

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <linktexts>
            <linktext>
                <text>Xovi</text>
            </linktext>
            <linktext>
                <text>&amp;#8618; zurWebsite</text>
            </linktext>
        </linktexts>
    </apiResult>
</result>