| 
  • If you are citizen of an European Union member nation, you may not use this service unless you are at least 16 years old.

  • Whenever you search in PBworks, Dokkio Sidebar (from the makers of PBworks) will run the same search in your Drive, Dropbox, OneDrive, Gmail, and Slack. Now you can find what you're looking for wherever it lives. Try Dokkio Sidebar for free.

View
 

Freewave API Dokumentation

This version was saved 13 years, 9 months ago View current version     Page history
Saved by Walter Krivanek
on April 23, 2009 at 9:43:55 pm
 

Freewave API Dokumentation


Beta

Bitte beachten Sie, dass sich die Freewave API derzeit im Beta Stadium befindet und noch Änderungen daran durchgeführt werden können. Im Falle einer Änderung werden alle Nutzer der Freewave API rechtzeitig vorher Informiert.

Allgemeines

Frequenzlimitierung

Alle Anfragen an die Freewave API unterliegen einer Frequenzlimitierung. Im Normalfall liegt diese bei 60 Anfragen pro 60 Minuten, gemessen ab der ersten Anfrage. Übertritt ein Client dieses Limit, wird er über einesprechende Fehlermeldung im gewünschten Format mit dem HTTP Status Code 400 darüber informiert.

Sollte ein Client diese Fehlermeldung über einen gewissen Zeitraum hinaus ignorieren und weiter Anfragen an den API Server senden, wird die IP-Adresse dieses Clients für einen längeren Zeitraum komplett gesperrt.

Sollte diese Limitierung für Ihre Applikation zu restriktiv sein, kontaktieren Sie uns, damit wir Ihre Limitierung individuell anpassen können.

Um einen Überblick über verbleibende Anfragen zu haben, werden mit jeder Antwort die Eckdaten der Limiterung in den HTTP Kopfdaten mitgeschickt.

  • X-RateLimit-Limit: Die Limitierung der Anfragen, z.B. 60.
  • X-RateLimit-Remaining: Die Anzahl der noch möglichen Anfragen bis zum Reset
  • X-RateLimit-Reset: Der Zeitpunkt, wann dieses Limit zurückgesetzt wird (standardmäßig nach 60 Minuten nach der jeweils ersten Anfrage) im Unix-Zeitformat.

API Schlüssel

Mit jeder Anfrage an die API muss ein API Schlüssel mitgeschickt werden. Durch den API Schlüssel wird nicht der Endnutzer, sondern die Applikation identifiziert. Kontaktieren Sie uns, um einen API Schlüssel für Ihre Applikation zu erhalten.

Formate und Kodierung

Derzeit antwortet die Freewave API im XML-Format. JSON und weitere Formate sind bereits in Arbeit.

Alle Antworten der Freewave API werden mit der UTF-8 Zeichenkodierung kodiert.

Fehlermeldungen

Die Freewave API gibt Fehlermeldungen immer im gewünschten Format (sofern bekannt) und mit einer sprechenden Fehlermeldung auf Englisch zurück. Hier ein Beispiel im XML-Format:

<?xml version="1.0" encoding="UTF-8"?>
<error>
     <request>/hotspots/2320000x.xml</request>
     <message>No hotspot(s) found.</message>
</error>

HTTP Status Codes

Bei allen Antworten, inklusive Fehlermeldungen, werden passende HTTP Status Codes zurückgegeben. Folgende kommen dabei zur Anwendung:

Code Bedeutung Erklärung
200 OK Die Anfrage wurde erfolgreich bearbeitet.
304 Not Modified Es stehen keine neuen Daten seit der letzten Anfrage zur Verfügung.
400 Bad Request Die Anfrage war Fehlerhaft. Bitte beachten Sie die zurückgegebene Fehlermeldung.
404 Not Found Die Anfrage brachte kein Ergebnis bzw. wurde ein falscher Pfad verwendet.
500 Internal Server Error Ein Fehler ist aufgetreten. Im Normalfall werden die Serveradministratoren automatische davon in Kenntnis gesetzt.
503 Service Unavailable Der API Server ist überlastet.

Anfragen

Die URL einer Anfrage an die Freewave API setzt sich aus folgenden Teilen zusammen:

http://api.freewave.at/hotspots/befehl.format?apikey=api-schlüssel[&weitere=parameter]

  • Befehl: Es gibt mehrere Befehle (siehe Punkt Befehle).
  • Format: Die Dateierweiterung des gewünschten Formats, also z.B.: xml (siehe Punkt Formate und Kodierung)
  • API-Schlüssel: Ihr API Schlüssel (siehe Punkt API Schlüssel)
  • Weitere Parameter: Manche Befehle erlauben weitere oder optionale Parameter.

     

Comments (0)

You don't have permission to comment on this page.