API Dokumentation
API Keys
Ohne einen API Key kannst Du nichts tun.
Dein API Key
Deinen API-Schlüssel siehst Du hier, wenn Du angemeldet bist.
API Schnittstellen
Es gibt verschiedene API-Schnittstellen, die alle das selbe tun, sich aber unterschiedlich ansprechen lassen. Du kannst Dir diejenige aussuchen, die Deinen Bedürfnissen entspricht.
Die JSON Schnittstelle
Wird mittels http://hatr.org/api/json/<methode> aufgerufen.
Alle Parameter und Werte werden als JSON-Datensatz im POST-Body des HTTP-Request übermittelt, das Ergebnis folgt als JSON-Datensatz im Body des HTTP-Response
Die JSONP Schnittstelle
Wird mittels http://hatr.org/api/jsonp/<methode> aufgerufen.
Die Parameter und Werte werden im QUERY_STRING des HTTP-GET-Requests übergeben. Der Zusätzliche Parameter callback wird als Callback-Methodenaufruf in der Antwort verwendet. Aufgepasst: Die author.whatever Parameter müssen in der Form author[whatever] übergeben werden.
XML/RPC Interface
Wird mittels http://hatr.org/api/xmlrpc ansgesprochen.
Der erste <param /> der Anfrage muss dabei ein <struct /> sein, das alle Parameter und Werte enthält. Alle weiteren <param />s werden ignoriert.
Methoden
apikey()
Prüft, ob Dein API Key gültig ist.
Parameter
- (str)
apikey: Dein API Key
Rückgabe
- (bool)
status: true oder false, je nachdem.
submit()
Einen Hate übermitteln
Parameter
- (str)
apikey: Dein API-Key - (str)
text: Der Text des Hasskommentars - [(str)
date: Datum des Hasskommentars, am besten nach ISO 8601 oder so] - [(str)
author.name: Name des Hasskommentierenden] - [(str)
author.ip: IP-Adresse des Hasskommentierenden] - [(str)
author.email: E-Mail-Adresse des Hasskommentierenden] - [(str)
author.www: URL des Hasskommentierenden]
Rückgabe
- (bool)
status: true bei erfolgreicher Übermittlung - [(str)
identifier: Eindeutige ID des übermittelten Hasskommentars]
