getLinkedPages

Returns all URLs being the link destination of a domain. The link destination get returned without Get parameter and also without the anchor text.

Route /links/getLinkedPages[/:key[/:domain[/:format[/:limit[/:skip]]]]]
Necessary parameter domain
Optional parameter limit (max:1000)
skip

format
Return values linkedPage
Hints
Hinweise Limit: The maximum limit is 1000. To get more results, please use the parameter skip.
resultCount: Shows the amount of the result without limits. Usefull for pagination.

Parameter

Labeling Description Values margin Default value
domain Contains a qualified domain name. (www.)?(A-Z|a-z|0-9)+. (a-z)+
limit Defines the amount of the returned results. (max:1000) 0-1000 100
skip Defines the starting page of the result. One page equals the the value of limit. (0-9)+ 0
format Defines in which format the result will be returned. json|xml json

Return values

Labeling Description Values margin
linkedPage URLs of the linking websites string

Messages

Message Description
maximum limit exeeded The maximum limit is reached.
no permission The key has no permission to access this function.
internal error An internal error occured.
param missing A required parameter is missing.
param invalid The value of a parameter is not valid.
result empty The request was successful, but the result itself is empty.
cost error The current credit amount is not sufficient to handle the request.
0k. The processing was successful.

Exemplary code

<?php
$root = 'https://suite.xovi.net/api/';

$arrayParams = array(
    'service' =>'links',
    'method' =>'getLinkedPages',
    'key' =>'myPersonalKey',
    'domain' => 'www.xovi.de',
    'format' =>'json',
 );
$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":[
     {"linkedPage":"http:\/\/www.xovi.de"},
     {"linkedPage":"http:\/\/www.xovi.de\/2009"},
]
}

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <linkedpages>
            <linkedpage>
                <linkedPage>http://www.xovi.de</linkedPage>
            </linkedpage>
            <linkedpage>
                <linkedPage>http://www.xovi.de/2009</linkedPage>
            </linkedpage>
        </linkedpages>
    </apiResult>
</result>