logo

Einführung zur API

Das Openrat-CMS besitzt eine Scripting-Schnittstelle oder Programm-API, mit der das CMS gesteuert werden kann.

Die Server-API wird üer HTTP-Parameter aufgerufen, die Antworten bestehen aus einem XML- oder JSON-Dokument.

Im Prinzip ist die Schnittstelle die gleiche, die auch der Webbrowser benutzt, die Ausgabe besteht nur nicht aus der HTML-Anzeige, sondern aus maschinenlesbaren Dokumenten.

Wie funktioniert das

Der Client muss nichts weiter tun, als im HTTP-Request das gewünschte Format anzufordern. Dazu wird der HTTP-Header "Accept" verwendet. Normalerweise verwendet der Browser hier "text/html" und der OpenRat-Server liefert dann die HTML-Seite. Wird jedoch "Accept: application/xml" angegeben, so liefert der OpenRat-Server die Daten im XML-Format. Alle Informationen aus der HTML-Seite findet man nun im XML-Dokument wieder.

Hintergrund

OpenRat macht nichts weiteres als die Daten, die sonst für die HTML-Anzeige verwendet werden, per XML oder JSON an den Client zu liefern. Die Programmlogik ist exakt die gleiche, als wenn Sie OpenRat über den Browser bedienen, nur das Ausgabeformat ist unterschiedlich.

Möglichkeiten

Was Sie mit dieser Schnittstelle machen, entscheiden Sie. Man kann Seiten anlegen, Berechtigungen setzen, Projekteinstellungen verändern, Benutzer anlegen. Eben alles, was auch über den Webbrowser möglich ist.