getSearchEngines

Gibt alle täglich oder wöchentlich gecrawlten Suchmaschinen zurück. (Enthält für andere Funktionen relevante Daten.)

Route /keywords/getSearchEngines[/:key[/:format[/:limit[/:skip[/:interval]]]]]
Erforderliche Parameter
Optionale Parameter interval
limit (max:1000)
skip
format
Rückgabewerte id
host
country
city
Querschnittverbindungen
Hinweise Limit: Das maximale Limit ist 1000. Um mehr Ergebnisse zu erhalten, benutzen Sie den Parameter Skip.

Parameter

Bezeichnung Beschreibung Wertebereich Standartwert
interval Legt fest, ob die täglich oder eben die wöchentlich gecrawlten Suchmaschinen gewünscht sind. daily|weekly weekly
format Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll. json|xml json
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

Rückgabewerte

Bezeichnung Beschreibung Wertebereich
id Enthält einen eindeutigen Bezeichner der Suchmaschine. (0-9)+
host Enthält den Namen der Suchmaschine. Dieser besteht aus Top-Level-Domain und Domain (Bsp.: google.de). (a-z)+.(a-z)+
country Enthält den Standort der genannten Suchmaschine. (a-zA-Z)+
city Enthält den Standort der genannten Suchmaschine. (a-zA-Z)+

Meldungen

Nachricht Beschreibung
maximum limit exeeded Das maximale Limit wurde überschritten.
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' => 'keywords',
    'method'  => 'getSearchEngines',
    'key'     => 'myPersonalKey',
    '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":[
        {
            "id":"1",
            "host":"google.de",
            "country":"Germany",
            "city":null
        },
        {
            "id":"2",
            "host":"google.at",
            "country":"Austria",
            "city":null
        },
        {
            "id":"28",
            "host":"google.ch",
            "country":"Switzerland",
            "city":null
        },
        {
            "id":"51",
            "host":"bing.de",
            "country":"Germany",
            "city":null
        }
    ]
}

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <searchengines>
            <searchengine>
                <id>1</id>
                <host>google.de</host>
                <country>Germany</country>
                <city/>
            </searchengine>
            <searchengine>
                <id>2</id>
                <host>google.at</host>
                <country>Austria</country>
                <city/>
            </searchengine>
            <searchengine>
                <id>28</id>
                <host>google.ch</host>
                <country>Switzerland</country>
                <city/>
            </searchengine>
            <searchengine>
                <id>51</id>
                <host>bing.de</host>
                <country>Germany</country>
                <city/>
            </searchengine>
        </searchengines>
    </apiResult>
</result>