Facebook Twitter Foursquare Google+ Youtube RSS Feed
Autoren
part of whatchado
WHATCHADO
ON TOUR
PROJECTS
JOB INSIGHTS
COMMUNITY
BACKSTAGE
Scroll Left
Scroll Right
4
Mär
2012
Veröffentlicht von Kambis

whatchado und du - bring uns auf deine Seite! Die API auf den Punkt gebracht.

Mit dem Relaunch bekommen auch die Techniker unter euch ein paar Goodies. Eines der ganz besonderen stelle ich euch heute vor: Mit unserer API könnt ihr whatchado-Videos bei euch einbinden.

whatchado auf deiner Seite in drei Schritten

1. Hol dir einen API key

Nachdem sich das Feature noch in der Testphase befindet und wir euch deswegen gern ein bisschen kennen lernen würden, schreib einfach eine Mail. Der Betreff sollte "API key" beinhalten (damit unsere Mailgnome das ganze ordentlich einordnen können) und die Mail folgende Angaben:
a) Wo willst du whatchado einbinden? (einfach die URL deiner Seite)
b) Was willst du damit tun?
c) [optional] Fehlt dir noch was bestimmtes an der API?
Wir legen dir dann einen Key an. Wichtig ist, dass du mit diesem Key erstmal auf 500 Abfragen pro Tag beschränkt bist, aus Performancegründen nämlich.

2. Lies den Rest dieses Posts

Die aktuelle Dokumentation gibts nur hier. Sobald die API halbwegs stable ist wird das natürlich durch eine richtige Dokumentation ersetzt.

3. Schreib deine Anbindung

Wir nehmen GET und/oder POST-Parameter und liefern JSON. Das sollte für dich alles sehr leicht machen.
Kurz ein Wort zur Sicherheit: In einem nebenläufigem Leben bin ich Sicherheitsforscher. Wir loggen Anfragen mit ungültigen Parametern und andere Versuche unsere Sicherheit zu stören und sperren deinen Key bei zu vielen Fehlversuchen. API keys bruteforcen ist übrigens auch nicht sehr ratsam (ja, die sind random).

Alles klar? Hier die Dokumentation:

GET oder POST an http://whatchado.net/api.

Parameter:
Authentifizierung (required)
key - den kriegst du von uns. Einfach so wie er in der Mail steht verwenden.
Suche (eins oder mehrere davon)
id - die Video-ID, normal ist die in der Form vorname_nachname.wvideo. Ist eindeutig, es wird als nur ein Video zurückgeliefert.
job - eine genaue Job-Bezeichnung (URLencoding nicht vergessen) wie etwa "Journalist".
firstname - Erklärt sich von selbst
lastname - Selbiges

Response:

Ganz einfaches JSON in UTF-8. Vom Format her sieht das so aus:
{
  results:[
          id:string,
          title:string,
          url:string, // href zu unserer Video-Seite
          thumbnail:string, // Direkt als Bild einbindbar
          firstname:string,
          lastname:string,
          job:array[string],
          description:string,
          date:timestamp
      ],
  errors:string
}

Wenn der "errors"-String nicht leer ist, darfst du den Wert von result nicht verarbeiten. *sad trombone*

Falls irgendetwas noch nicht ganz klar ist: Schick deine Parameter an http://whatchado.net/api/demo und du kriegst die Ausgabe schön formatiert und ein Anwendungsbeispiel zum kopieren gratis dazu! ;)

Ansonsten?






Cheers,

Mansch

Tags:
API
Community
Technik

Kommentar
(Pflichtfeld)
(Pflichtfeld)



Bitte geben Sie den Text auf dem Bild ein.



Impressum

Paulanergasse 13/Top 6
1040 Wien
+43 699 10924268
office@whatchado.net
© 2012, whatchado
part of whatchado