cb-in | CultureBase | Kulturserver

cb-in ist der Bereich von Culturebase, um Ihre Daten via upload massenhaft zu importieren. Im Anfang werden hier die Profi-Informationen im Vordergrund stehen. In Zukunft werden Sie aber hier auch Strategien finden, wie technisch ungeschulte Partner des Netzwerks massenhaft Daten aus bestehenden Datenbaken in CultureBase überführen können.

cb-in

Datensätze in CultureBase importieren

[ cb-in.de ]

!!! Wichtige Neuigkeiten !!!

30. September 2007

Seit heute haben sich die Kategorien IDs geändert. Bitte aktualisieren Sie ihre zu importierenden XML Daten dementsprechend.
Eine neue, bessere Übersicht über alle Kategoriensysteme inklusive IDs findet sich unter dieser Adresse:
http://cb.heimat.de/interface/api/categories.php

7. Januar 2007

Um die XML Schnittstelle zu erweitern und zu verbessern, gibt es einen neuen Parameter und darauf bezogene Logik beim Import.

Durch Setzen des Parameters "ignorePics" auf "1" kann der Import veranlasst werden, bereits hochgeladene Bilder oder manuell über cb-event hochgeladene Bilder von Terminen unangetastet zu lassen. Wird der Parameter nicht gesetzt (oder nicht auf 1 gesetzt), so werden die Bilder komplett aus der XML Datei importiert. Alle anderen Bilder werden gelöscht.

Informationen zum Import

Wie werden die Daten importiert?
Die XML Daten müssen generell an diese URL gesendet werden:
http://cb.heimat.de/interface/importfile.php

Es müssen/können verschiedene GET Parameter übergeben werden. Im Folgenden werden alle Parameter aufgelistet:
- "u" * : der cb3/culturebase Benutzername des Accounts für den die Daten importiert werden sollen
- "p" * : das Passwort des Accounts für den die Daten importiert werden sollen
- "test" : wenn test=1 gesetzt ist, werden die Daten nicht importiert, sondern lediglich Fehlermeldungen oder eine Erfolgsmeldung herausgegeben
- "sync" : wenn sync=1 gesetzt ist, werden die Daten synchronisiert. Dies bedeutet, daß alle Termine, die sich im XML befinden aktualisiert oder neu eingetragen und alle anderen Termine gelöschen werden
- "xmlfileurl" : wenn xmlfileurl gesetzt ist, werden die Daten von der angegebenen URL heruntergeladen
- "ignorePics" : wenn ignorePics gesetzt ist, werden bereits importierte oder per Hand in cb-event eingegebene Bilder nicht überschrieben / geändert und alle picture Elemente im importierten XML ignoriert
*: Pflichtparameter

Es existieren drei Möglichkeiten, die Daten zu importieren:
- Import via POST Request (Push)
  
  Hinter diesem Link liegt ein Skript, welches per POST Request angesprochen werden kann. Dadurch wird der automatisierte Dateiupload realisiert. Etwaige Fehler-/Erfolgsmeldungen werden unmittelbar zurückgegeben und können danach entsprechend abgefangen werden. Im FILE Array muss die Datei unter dem key 'file' liegen. Die Authentifizierung geschieht mittels der POST Parameter "u" und "p" für Username und Passwort. Die Daten werden entsprechend unter dem Account abgespeichert, der sich authentifiziert hat. Wird der Parameter "test" mit dem Wert 1 übergeben, so werden die Termine nicht abgespeichert, sondern nur eine Erfolgsmeldung zurückgeliefert.
  
  Auf der PHP-FAQ Seite liegt ein Beispielskript, in dem beschrieben wird, die man einen HTTP POST Request mit Dateiupload absetzt:
  Beispielskript
  
  Diese könnnen danach beispielsweise im Redaktionssystem cb-event kontrolliert oder nachbearbeitet werden.
  
  WICHTIG für Partner aus dem Bühnenbereich
  Daten, die später weiter in cb-stage gepflegt werden sollen, dürfen mit cb-event betrachtet, aber nicht verändert bzw. gespeichert werden. Ansonsten konnen Veränderungen derzeit verloren gehen. Dieser Zustand ist nur eine Übergangsphase!
  
  Mit weiteren Fragen wenden Sie sich bitte an technik@heimat.de.
- Import via POST String (Push)
  
  Bei dieser Möglichkeit, schreibt man die XML Datei als String in das POST Array und zwar in den Schlüssel xml. Das Skript lädt dann diesen String, validiert das XML gegen das XSD und importiert die Daten.
- Import via "URL retrieval" (Pull)
  
  Ist der GET Parameter xmlfileurl auf eine gültige URL gesetzt, so versucht das Importskript, die angegebene XML Datei herunterzuladen, zu validieren und zu importieren.
Import FAQ
XSD-File zum Herunterladen (XSD Format) || interfaceformat.xsd
XML Beispieldatei zum Herunterladen
XML Validierung
Um eine erstellte XML Datei zu validieren existieren etliche Freeware Tools und Online Validatoren:
Import API
Momentan wird eine API aufgebaut, über die Hilfsfunktionen erreichbar sind, um die Importe zu steuern und aktuelle Daten wie z.B. Kategorien-IDs herunterladen zu können.

Es existieren bis jetzt folgende Möglichkeiten:
- "REST"-artige Schnittstelle
  Diese Schnittstelle kann über einfache GET Parameter angesteuert werden. Sie ist erreichbar unter der URL http://cb.heimat.de/interface/api/rest.php
  
  Prinzipiell muss zunächst immer ein Login erfolgen über die Parameter "u" für den Accountnamen und "pwd" für das Passwort. Es wird momentan an einer https Lösung gearbeitet, um die Schnittstelle sicher zu machen.
  
  Beispiel für einen Login: http://cb.heimat.de/interface/api/rest.php?u=<ACCOUNTNAME>&pwd=<PASSWORT>
  
  Hat man sich erfolgreich eingeloggt, kann man mittels "m" Methoden/Funktionalitäten ansteuern und diese mit "p" parametrisieren.
  
  Zur Zeit existieren folgende Möglichkeiten für den Parameter "m":
  - del: zum Löschen aller/einzelner Cluster eines Accounts. Ist "p" auf "all" gesetzt, so werden alle Cluster des eingeloggten Accounts gelöscht. Wird eine ID übergeben, so wird nur dieses Cluster gelöscht (sofern es gefunden wird).
    
    Beispiel:
    http://cb.heimat.de/interface/api/rest.php?u=<ACCOUNTNAME>&pwd=<PASSWORT>&m=del&p=all
  - xml: zum Ausgeben eines Clusters im XML Format. Ist "p" gesetzt, so wird der Parameter als Cluster ID interpretiert. Ist "p" nicht gesetzt, werden alle Cluster des eingeloggten Accounts ausgegeben.
    
    Beispiel:
    http://cb.heimat.de/interface/api/rest.php?u=<ACCOUNTNAME>&pwd=<PASSWORT>&m=xml
  - showAccounts: zeigt alle Accounts an, die das mit "p" bestimmte Kategoriensystem nutzen, d.h. hierfür Termine eingegeben haben. Wichtig: Login muss über das Master Passwort erfolgen!
    
    Beispiel:
    http://cb.heimat.de/interface/api/rest.php?u=<ACCOUNTNAME>&pwd=<PASSWORT>&m=showAccounts
  - auth: um einen Account zu authentifizieren. "u" setzt den Accountnamen und "pwd" das Passwort.
    
    Beispiel:
    http://cb.heimat.de/interface/api/rest.php?u=<ACCOUNTNAME>&pwd=<PASSWORT>&m=auth
  - showIni: zeigt das komplette cb-out Inifile an. Der Name des Inifiles wird über "p" gesetzt
    
    Beispiel:
    http://cb.heimat.de/interface/api/rest.php?u=<ACCOUNTNAME>&pwd=<PASSWORT>&m=showIni
- Kategorien für das Kategoriensystem "ks-buehnen"
- Veröffentlichen/Unveröffentlichen aller Termine eines Accounts
  
  Unter http://cb.heimat.de/interface/api/publish_events.php können Termine veröffentlicht und auf unveröffentlicht gesetzt werden.
  
  Hierbei existieren folgende Parameter, die einfach per GET übertragen werden:
  u: username
  p: passwort
  publish:
  1 => veröffentlichen
  0 => auf unveröffentlicht setzen
  
  Beispiel:
  http://cb.heimat.de/interface/api/publish_events.php?u=<USERNAME>&p=<PASSWORT>&publish=1
  
  Setzt alle Termine des Accounts "u" auf veröffentlicht.