Babblr API

Babblr bietet eine Schnittstelle, für Applikationen oder Mashups, um Babblr bezogene Daten abzufragen.

1. Konzepte

Die API wurde anhand der Twitter API entwickelt um die Integration von Babblr in vorhandene Programme zu vereinfachen. In der nächsten Zeit wird es auch noch eine erweiterte API geben, mit der zusätzliche Funktionen zugänglich gemacht werden. Trotzdem gibt es starke Abweichungen; falls es Fragen gibt kann man dem Babblr Profil eine @Frage stellen. Im Regelfall wird diese dann umgehend beantwortet.

2. Authentifizierung

Die Authentifizierung mit der Babblr API läuft über das HTTP BASIC AUTH Protokoll. So ziemlich alle API Abfragen erfordern eine Authentifizierung mit dem Server, um diese zu nützen.

3. Kodierung

Die Antworten werden immer mit UTF-8 kodiert geliefert, außerdem sind Sonderzeichen HTML Entity enkodiert.

4. Abfragen

Die folgenden Abfragen werden momentan von der Babblr API angeboten:

4.1 Babbl Zeitachsen Abfragen

Diese Abfragen enthalten Informationen über diverse Ansichten der Zeitachse, zum Beispiel die öffentliche Ansicht (wie auf der Startseite), die vom aktuellen oder eines gewünschten Users, oder die des aktuellen Users und seiner Freunde. Außerdem können auch spezielle Ansichten angefordert werden, die dann Informationen wie alle @Antworten enthalten.

4.1.1 public_timeline

Gibt die "Public Timeline" zurück. Diese Antwort wird für 60 Sekunden zwischen gespeichert, häufigere Abfragen machen also keinen Sinn.

URL: http://api.babblr.de/statuses/public_timeline.format
Formate: xml, json, rss
Method(s): GET

4.1.2 friends_timeline

URL: http://api.babblr.de/statuses/friends_timeline.format
Formate: xml, json, rss
Method(s): GET
Parameters:'

since Optional. Z.B: http://api.babblr.de/statuses/friends_timeline.rss?since=Tue%2C+27+Mar+2007+22%3A55%3A48+GMT
since_id Optional.
count Optional.
page Optional.

4.1.3 user_timeline

URL: http://api.babblr.de/statuses/user_timeline.format
Formats: xml, json, rss, atom
Method(s): GET
Parameters:

id Optional. Z.B: http://api.babblr.de/statuses/user_timeline/12345.xml or http://api.babblr.de/statuses/user_timeline/babblr.json.
count. Optional.
since Optional.
since_id Optional.
page Optional.

4.1.4 replies

URL: http://api.babblr.de/statuses/replies.format
Formats: xml, json, rss, atom
Method(s): GET

Parameters:

page. Optional.
since. Optional.
since_id. Optional.

4.2 Einzelne Babbls

Mit diesen Abfragen können einzelne Babbls abgefragt, gelöscht oder geposted werden.

4.2.1 show

URL: http://api.babbr.de/statuses/show/id.format
Formats: xml, json
Method(s): GET

Parameter:
id. Erforderlich.

4.2.2 update

URL: http://api.babblr.de/statuses/update.format
Formats: xml, json.
Method(s): POST

Parameter:
status. Erforderlich.

4.2.3 destroy

URL: http://api.babblr.de/statuses/destroy/id.format

Formats: xml, json
Method(s): POST, DELETE

Parameter:
id. Erforderlich.

4.3 Benutzer Abfragen

4.3.1 friends

Antwortet mit Informationen über alle Freunde des Benutzers.
URL: http://api.babblr.de/statuses/friends.format
Formats: xml, json
Method(s): GET

Parameter:
id. Optional.
page. Optional.
since. Optional.

4.3.2 followers

Antwortet mit Informationen über alle Fans.
URL: http://api.babblr.de/statuses/followers.format
Formats: xml, json
Method(s): GET

Parameter:

id. Optional.
page. Optional.

show (N/A)

URL: http://api.babblr.de/users/show/id.format
Formats: xml, json
Method(s): GET

4.4 Direkt Nachrichten

Mit diesen Abfragen können die empfangenen oder versendeten Direktnachrichten des aktuell Authentifizierten Benutzers abgefragt werden.

4.4.1 direct_messages

URL: http://api.babblr.de/direct_messages.format
Formats: xml, json, rss
Method(s): GET

Parameter:
since.
since_id.

4.4.2 sent

URL: http://api.babblr.de/direct_messages/sent.format
Formats: xml, json
Method(s): GET

Parameter:
since. Optional.
since_id. Optional.

4.4.3 new (nicht verfügbar)

Um eine Direktnachricht zu versenden sollte die status/update Methode aus 4.2.2 verwendet werden. Der Status Parameter sollte dann mit einem d gefolgt von einem Benutzernamen beginnen z.B: "d Babblr eine Nachricht direkt an Babblr"

URL: http://api.babblr.de/direct_messages/new.format
Formats: xml, json
Method(s): GET,POST

Parameter:
user. Erforderlich.
text. Erforderlich.

4.4.4 destroy

URL: http://api.babblr.de/direct_messages/destroy/id.format
Formats: xml, json
Method(s): POST, DELETE

Parameter:
id. Erforderlich.

4.5 Beziehungs Abfragen

4.5.1 create

Erstellt eine Beziehung zwischen dem aktuellen Benutzer und dem angegeben Benutzer (id Parameter).

URL: http://api.babblr.de/friendships/create/id.format
Formats: xml, json
Method(s): GET,POST

Parameter:
id. Erforderlich. Die ID des Benutzer oder der Benutzername.
type. Optional (Standardwert: Subscribed). Der Typ der Beziehung (z.B: Subscribed=>Benutzer abonnieren, Delivery=>Benachrichtigungen für diesen Benutzer aktivieren oder Poke=>Knuffeln)

4.5.2 destroy

Löst eine Beziehung zwischen dem aktuellen Benutzer und dem angegeben Benutzer (id Parameter) auf.
URL: http://api.babblr.de/friendships/destroy/id.format
Formats: xml, json
Method(s): GET,POST

Parameter:
id. Erforderlich. Die ID des Benutzer oder der Benutzername.
type. Optional (Standardwert: Subscribed). Der Typ der Beziehung (z.B: Subscribed=>Benutzer abonnieren, Delivery=>Benachrichtigungen für diesen Benutzer aktivieren)

4.5.6 exists

Überprüft ob eine Beziehung vom Typ (type) zwischen user_a und user_b besteht.

URL: http://api.babblr.de/friendships/exists.format
Formats: xml, json
Method(s): GET, POST

Parameter:
user_a. Required. Die ID des Benutzer oder der Benutzername dessen Beziehung zu user_b überprüft werden soll.
user_b. Required. Die ID des Benutzers user_b oder der Benutzername.
type. Optional (Standardwert: Subscribed). Der Typ der Beziehung (z.B: Subscribed=>Benutzer abonnieren, Delivery=>Benachrichtigungen für diesen Benutzer aktivieren oder Poke=>Knuffeln)

4.6 Benutzer Abfragen

4.6.1 verify_credentials

Überprüft ob das Passwort für den zu authentifizierenden Benutzer korrekt ist.

URL: http://api.babblr.de/account/verify_credentials.format
Formats: xml, json
Method(s): GET, POST