Die API muss zwingend verfügbar gemacht werden indem sie eingebunden wird. Wie das geht erfahren Sie hier.
Die grundlegende Syntax lautet folgenermaßen.
- <?php
- api_edit(
- $data, // Inhalt
- $file, // Datei
- 'edit', // Aktion
- $container_id, // Container ID
- $article_id, // Artikel ID
- $publish, // Publikationseinstellung
- // (0=nicht publizieren;
- // 1=publizieren;
- // 2=Einstellung beibehalten)
- $username, // API-Username
- $password, // API-Passwort
- false, // Regeln ignorieren (true|false)
- false // Fehler ausgeben (true|false)
- );
- ?>
$data muss ein Array sein. Es enthält die Felder und den entsprechenden Wert.
Beispiel:
Dieses Beispiel zeigt wie man die Felder title
und textfeld
befüllen würde.
- <?php
- $data['title'] = mysql_real_escape_string('Titel des Artikels');
- $data['textfeld'] = mysql_real_escape_string('Ich bin der Text.');
- ?>
Wenn $data
leergelassen wird, wird kein Feld befüllt.
HINWEIS: Wir empfehlen dringend die Daten mit der Funktion mysql_real_escape_string() zu sichern bevor sie ins System geschrieben werden.
$file muss ebenfalls ein Array sein und nur befüllt werden, wenn man eine Datei hochladen will.
Beispiel:
Das Feld uploadfeld
wird mit dem Inhalt der hochgeladenen Datei datei
befüllt.
- <?php
- $file['uploadfeld'] = $_FILES['datei'];
- ?>
Die Aktion muss den Wert edit
enthalten. Dies ist erforderlich, weil die Funktion api_edit()
auch zur Erstellung von Inhalten verwendet werden kann. Dann wäre als Wert news
erforderlich.
$container_id muss die Container-ID angeben in die der Inhalt gespeichert werden soll.
$article_id ist die ID des Artikels in dem das Feld bearbeitet werden soll.
$publish regelt, ob der erzeugte Inhalt sofort publiziert wird oder erst noch publiziert werden muss.
$username und $passwort sind die Zugangsdaten eines Backend-Benutzers. Der Artikel bekommt diesen Benutzer als Ersteller zugewiesen. Wir empfehlen einen eigenen Benutzer für API-Operationen anzulegen. So kann später sehr einfach nachvollzogen werden wie der Artikel entstanden ist. Es sind auch verschiedene API-Benutzer möglich.
Der Wert für die Fehlercode-Ausgabe ist standardmäßig auf false
gesetzt. Wenn man Fehlercodes erhalten möchte, muss der Wert auf true
gesetzt werden. Es werden dann der Feldname, Fehlercode und die Fehlermeldung in einem Array zurückgegeben.