Einleitung

« Dokumentation für Entwickler

Dieses Dokument beinhaltet Informationen über die XML-RPC Schnittstelle, die von Nucleus unterstützt wird und den Fehlermeldungen, die zurückgegeben werden können. Bitte beachten Sie, das die Ausprägung der Schnittstelle eventuellen Änderungen in der Zukunft unterliegt.

Die Blogger Schnittstelle (XML-RPC)

Nucleus implementiert die Blogger API. Diese erlaubt Tools und Diensten, die mit Blogger kommunizieren können auch eine Kommunikation mit Nucleus. Aufgrund der Architektur von Nucleus werden einige Paramater anders interpretiert. Beachten Sie dafür die untenstehenden Informationen. Die Struktur der Methodenaufrufe und der Rückgaben sind natürlich identisch.

Die folgende Liste beinhaltet die vorhandenen Methoden. Klicken Sie auf die Links um mehr Informationen aus der Blogger API zu bekommen oder besuchen Sie die Blogger API Newsgruppe.

• blogger.newPost
• blogger.editPost
• blogger.getPost
• blogger.deletePost
• blogger.getUsersBlogs
• blogger.getRecentPosts
• blogger.getUserInfo
• blogger.getTemplate
• blogger.setTemplate

Seitdem Nucleus intern anders strukturiert ist gibt es einige Unterschiede, wie Parameter behandelt werden. Hier eine Übersicht:

• Appkeys werden ignoriert.
• Neben dem Inhalt eines Posts hat ein Nucleusartikel immer auch einen Titel und eine Kategorie. Blogger kennt nur den Inhalt an sich (auch bekannt als 'contents'). Um diese Extras zu nutzen können Sie <title> und <category> im Inhalt, den Sie an Nucleus übermitteln nutzen. Diese Tags sind nur im Aufruf getRecentPosts implementiert.
• Was bei Blogger ein 'Teamplate' ist, ist bei Nucleus als Designvorlage (englisch 'Skin') bekannt. In einem System können mehrere Designvorlagen installiert sein, wobei jeder Blog eine andere Designvorlage nutzen kann. Die Methoden blogger.setTemplate und blogger.getTemplate bestimmen die Standarddesignvorlage, wie sie in den Blogeinstellungen eingestellt ist. Die Templates 'main' und 'archiveIndex' sind identisch zu den Nucleus Designvorlagenabschnitten 'index' und 'archivelist'
• Der publish Parameter wird benutzt um zu erkennen, ob ein Post als Entwurf gespeichert werden soll oder nicht. Beim Benutzen der Methode blogger.editPost wird der Parameter publish ignoriert, bis aus dem Entwurf eine Veröffentlichung wird.
• Nucleus macht keinen Unterschied zwsichen Vor- und Nachnamen, daher wird bei dem Aufruf der Methode getUserInfo das Feld 'lastname' in dem Ergebnis leergelassen und der volle Name im Feld 'firstname' gespeichert.
• Die Methode getRecentPostst gibt den Inhalt des Feldes authorName zurück und title als Extraparameter. Blogger hat das genauso gemacht, auch wenn es undokumentiert war.

metaWeblog API

Seit der Nucleusversion v1.1 wird die metaWeblog API unterstützt, was eine Erweiterung zu der Blogger API ist.

In der Version v2.5 wurde die Unterstützung für das newMediaObject und die Methode getRecentPosts hinzugefügt, da sie nicht in der ursprünglichen metaWeblog Spezifikation enthalten waren.

Eine Liste der verfügbaren Methoden ist untenstehend gelistet. Beachten Sie die Spezifikationen für mehr Informationen.

• metaWeblog.newPost
• metaWeblog.editPost
• metaWeblog.getPost
• metaWeblog.getCategories
• metaWeblog.newMediaObject (v2.5)
• metaWeblog.getRecentPosts (v2.5)

Mit der Version v3.22 unterstützen wir ebenfalls die mt_text_more und mt_allow_comments Erweiterungden der metaWeblog API.

Movable Type API

Seit der Version v2.5 werden von Nucleus Methoden der Movable Type API unterstützt.

Folgende Methoden sind vorhanden:

• mt.supportedMethods
• mt.supportedTextFilters
• mt.publishPost
• mt.getCategoryList
• mt.getPostCategories
• mt.setPostCategories
• mt.getRecentPostTitles
• mt.getTrackbackPings

Einige Hinweise:

• Nucleus unterstützt eine Kategorie pro Artikel. Das bedeutet, das alle Kategorien bis auf die primäre ignoriert werden.
• Trackbacks sind im Nucleus Basispaket nicht enthalten (es ist jedoch als Plugin verfügbar). Die Methode mt.getTrackbackPings gibt daher ein leeres Array zurück.
• Nucleus hat keine Textfilter implementiert. mt.getSupportedTextFilters liefert ein leeres Array.

Fehlermeldungen

Folgende Liste gibt einen Überblick über die Fehlertypen, die von den einzelnen Methoden zurück kommen können: