addProject

Fügt neue Projekte hinzu.

Route	/project/addProject[/:key[/:name[/:domain[/:description[/:format]]]]]
Erforderliche Parameter	name domain
Optionale Parameter	description format competitors (POST)
Rückgabewerte	hash name
Querschnittverbindungen	–
Hinweise	–

Parameter

Bezeichnung	Beschreibung	Wertebereich
domain	Enthält eine Domain.	(www.)?(A-Z|a-z|0-9)+. (a-z)+
name	Enthält einen Projektnamen.	(A-Z|a-z|0-9)+
description	Enthält eine Projektbeschreibung.	(A-Z|a-z|0-9)+
competitors	Array mit Mitbewerbern. (Wird per POST versendet)	siehe beispiel

Rückgabewerte

Bezeichnung	Beschreibung	Wertebereich
hash	Enthält einen eindeutigen Bezeichner des angelegten Projektes.	(0-9|a-z)+
name	Enthält die Bezeichnung des angelegten Projektes.	(A-Z|a-z|0-9)+

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/';
$arrayPath = array(
    'service' => 'project',
    'method'  => 'addProject',
    'key'     => 'myApiKey',
    'name'    => 'fromApi',
    'domain'  => 'www.xovi.de',
    'format'  => 'json',
);
$pathString = implode('/', $arrayPath);

$requestURL = $root.$pathString;

//build POST query
$arrayParams = array(
    'competitors' => array('www.competitor1.de', 'www.competitor2.com'),
);
$paramsString = http_build_query($arrayParams);

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);
//setup POST
curl_setopt($ch,CURLOPT_POST, 1);
curl_setopt($ch,CURLOPT_POSTFIELDS, $paramsString);

$output = curl_exec($ch);

curl_close($ch);

echo $output;

Beispielergebnisse

JSON

{
    "apiErrorCode":0,
    "apiErrorMessage":"0k.",
    "apiResult":[
        {
            "hash":32376,
            "name":"apiproject"
        }
    ]
}

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <projects>
            <project>
                <hash>32376</hash>
                <name>apiproject</name>
            </project>
        </projects>
    </apiResult>
</result>