getProjects

Gibt alle angelegten Projekte zurück. (Enthält für andere Funktionen relevante Daten.)

Rute	/project/getProjects[/:key[/:domain[/:format[/:limit[/:skip]]]]]
Erforderliche Parameter	–
Optionale Parameter	domain format limit skip
Rückgabewerte	hash name domain competitors
Querschnittverbindungen	–
Hinweise	–

Parameter

Bezeichnung	Beschreibung	Wertebereich	Standartwert
domain	Legt fest, welche Domain dem Projekt zugeordnet sein soll.	(www.)?(A-Z|a-z|0-9)+. (a-z)+	–
limit	Legt fest, wie viele Ergebniszeilen zurückgegeben werden sollen.	(0-9)+	10
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
hash	Enthält einen eindeutigen Bezeichner eines angelegten Projekts.	(a-f0-9){32}
name	Enthält eine Bezeichnung für ein angelegtes Projekt.	(A-Z|a-z|0-9)+
domain	Enthält ein Array mit den Indizes „hash“ und „domain“. Die Werte beschreiben die Hauptdomain des Projekts.	siehe Beispiel
competitors	Enthält ein Array mit den im Projekt hinzugefügten Mitbewerbern.	siehe Beispiel

Meldungen

Nachricht	Beschreibung
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' => 'project',
    'method' => 'getProjects',
    'key' => 'myPersonalKey',
    'domain' => 'NULL',
    '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":[
        {
            "hash":661dfc3980899852736864b4e43cd374,
            "name":"apiprojects",
            "domain":{
                "hash":"fa84390d885661e2",
                "domain":"www.xovi.de"
            },
            "competitors":{
                "competitor0":{
                    "hash":"fa940b03894669a9",
                    "domain":"mitbewerber1.de"
                },
                "competitor1":{
                    "hash":"fa940b03894665ab",
                    "domain":"mitbewerber2.com"
                }
            }
        }
    ]
}

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <projects>
            <project>
                <hash>661dfc3980899852736864b4e43cd374</hash>
                <name>apiprojects</name>
                <domain>
                    <hash>fa84390d885661e2</hash>
                    <domain>www.xovi.de</domain>
                </domain>
                <competitors>
                    <competitor0>
                        <hash>23lkjw5rljk</hash>
                        <domain>mitbewerber1.de</domain>
                    </competitor0>
                    <competitor1>
                        <hash>23lkjw5rljk</hash>
                        <domain>mitbewerber2.de</domain>
                    </competitor1>
               </competitors> 
            </project> 
         </projects> 
     </apiResult> 
  </result>