Seit 23.09.2009 ist Sidewiki offizieller Bestandteil der Google-Toolbar. Es ermöglicht jedem, jede Website zu kommentieren. Zum Verfassen von Kommentaren ist ein Google-Konto erforderlich.

An dieser Stelle möchten wir einen kleinen Einblick in die Anbindung über die bereitgestellte API Schnittstelle geben, um individuelle Lösungen für Applikationen entwickeln zu können.

Hinweis: Die nachfolgende Dokumentation setzt technisches Hintergrundwissen voraus.

Sidewiki als Atom/RSS Feed

Sendet man per HTTP GET

http://www.google.com/sidewiki/feeds/entries/webpage/ENCODED_URL/full

erhält man einen Atom-Feed als XML zurück.

ENCODED_URL ist mit der Adresse zu ersetzen, von welcher man die Sidewiki-Kommentare erhalten will. Wichtig ist hierbei, dass diese URL nach RFC 2396 Standard kodiert ist. http://www.visual-minds.de/ entspricht demzufolge http%3A%2F%2Fwww.visual-minds.de%2F

Achtung!
Die Seite http://www.visual-minds.de/ ist in Sidewiki eine andere als http://www.visual-minds.de – der abschließende Schrägstrich macht den Unterschied.

Ersetzt man den Wert full am Ende des URL mit default, wird ein vollwertige RSS-Feeds zurückgegeben, die mit einem RSS-Reader gelesen werden können.

Will man lediglich 5 Einträge haben, lässt sich dies mit dem Parameter max-result=5 bewerkstelligen. Die URL sieht dann wie folgt aus:

http://www.google.com/sidewiki/feeds/entries/webpage/http%3A%2F%2Fwww.google.de%2F/full?max-results=5

Der Standardwert für max-result ist 10, der höchstmögliche 150.

Ein weiterer Parameter ist start-index, mit dem man weitere Seiten der Ergebnisse ansteuern kann. Standardwert für start-index ist 1. Für die Kommentare auf Seite 2 sieht die URL folgendermaßen aus:

http://www.google.com/sidewiki/feeds/entries/webpage/http%3A%2F%2Fwww.google.de%2F/full?start-index=2

Wie man sieht, erhält man immer die neuesten Einträge. In der Standardanzeige über die Google-Toolbar sind die Kommentare nach Qualität sortiert. Dies lässt sich ebenfalls mit dem Paramenter sortorder und dem Wert quality realisierten. Bsp.:

http://www.google.com/sidewiki/feeds/entries/webpage/http%3A%2F%2Fwww.google.de%2F/full?sortorder=quality

Weitere Werte sind updated (die zuletzt bearbeitetenden Kommentare zuerst) und published (zuletzt veröffentlichte zuerst), wobei published ohne Angabe des Parameters sortorder der Standardwert ist.

Eine sehr hilfreiche Parameter-Wert-Kombination ist prettyprint=true, wodurch das XML lesbarer zurückgegeben wird. Besonders in der Entwicklungszeit kann dies von Vorteil sein.

Kommentare eines Autors

Mit dem HTTP GET-Request

http://www.google.com/sidewiki/feeds/entries/author/AUTHOR_ID/full

lassen sich die Kommentare eines Verfassers übermitteln. AUTHOR_ID ist mit der eindeutigen Google Profil ID zu ersetzen.

Für die Einträge des aktuellen Users kann man AUTHOR_ID mit me ersetzen. Hierfür ist allerdings eine vorherige Authentifizierung bei Google notwendig.