GiftköderRadar[API] – Grundlagen

Abgelegt von Sascha Schoppengerd am 22.07.2011 um 08:46 Uhr, 1 Kommentar

Bei der neuen GiftköderRadar[API] handelt es sich um einen REST­ful Web­ser­vice, bei dem jede Res­source über eine gesonderte URL ange­spro­chen wird.

Die verschiedenen Operationen die mit einer Res­sour­ce durchgeführt werden sollen, können bei dieser Technik direkt über den jeweiligen HTTP REQUEST gesteuert werden.

  • HTTP_GET: Um Res­sour­cen zu lesen
  • HTTP_POST: Um Res­sour­cen zu erstellen
  • HTTP_PUT: Um Res­sour­cen zu aktualisieren
  • HTTP_DELETE: Um Res­sour­cen zu löschen

Der API Endpunkt

[sourcecode language=“plain“ padlinenumbers=“false“]
http://www.giftkoeder-radar.com/api/1.0/{ressource}[/{id}][/{methode}]
[/sourcecode]

Para­me­ter Bedeu­tung
{res­source} Die Res­source, auf die zuge­grif­fen wer­den soll
{id} ID der Ressource
{methode} Methode der all­ge­mei­nen oder kon­kre­ten Ressource

Datenformat

Die Schnittstelle ver­steht sowohl für schrei­bende, als auch für lesende Requests ausschließlich das For­mat JSON. Fol­gede Punkte soll­ten zusätzlich beach­tet werden:

  • Alle Requests soll­ten UTF-8-kodiert sein
  • Bool­sche Werte sind ent­we­der 1 (true) oder 0 (false)
  • Bei schrei­ben­den Requests sollte der ent­spre­chende Content-Type (“application/json”) im HTTP-Header gesetzt wer­den

Authen­ti­fi­zie­rung

Ein Benutzer, die auf GiftköderRadar[API] zugreifen möchte, benötigt zunächst einen so genannten API-Schlüssel. Die­ser geheime Schlüssel ist praktisch das “Pass­wort” für die Benut­zung der Schnittstelle. Einen persönlichen API-Schlüssel für eure Anwendung könnt Ihr jederzeit kostenlos bei uns per E-Mail anfordern.

Alle API-Zugriffe sind grundsätzlich zustands­los, d.h. es werden vom System keine Sit­zun­gen oder ähnliches gespei­chert und daher muss der API-Schlüssel bei jedem Request mit über­mit­telt wer­den. Die Übermittlung selbst kann auf 2 verschiedene Arten stattfinden:

via. HTTP_GET

[sourcecode language=“plain“ padlinenumbers=“false“]
curl http://www.giftkoeder-radar.com/api/1.0/locations/?apiKey={apischluessel}
[/sourcecode]

via. HTTP-Header

[sourcecode language=“plain“ padlinenumbers=“false“]
curl -H ‚X-GKRadarApiKey: {apischluessel}‘ \
http://www.giftkoeder-radar.com/api/1.0/locations
[/sourcecode]

Tools

Zur Ausgabe des JSON Formates ist der normale Browser nicht ausreichend und daher emp­feh­len wir euch ent­we­der curl oder das Firefox-Plugin REST­Cli­ent.

Über den Autor

Sascha Schoppengerd gehört zu den zwei Gründern von GiftköderRadar und er kümmert sich bei uns um das Marketing und die Weiterentwicklung der Apps. Bei Fragen erreicht Ihr Sascha auf Twitter, Facebook, Xing und Google+.

1 Reaktion

[…] Ihr noch zwei API Schlüssel hinterlegen. Der eine Schlüssel ist für die Abfrage der Daten an unserer eigenen Schnittstelle und der zweite Schlüssel ist für die Anzeige der GoogleMaps Karte in eurem […]

Schreibe uns deine Meinung

Regeln: Wir freuen uns auf dein Feedback, sei jedoch stets respektvoll und bleibe beim Thema. Wir behalten uns jederzeit das Recht vor profane, belästigende und missbräuchliche Kommentare, sowie unerlaubte Werbung in den Kommentaren (Spam) zu löschen und Wiederholungstäter zu blockieren.