Stand
30. Mai 2009
Bei Fragen wenden Sie sich bitte einfach an uns.
Beta
Bitte beachten Sie, dass sich die Freewave API derzeit im Beta Stadium befindet und noch Verbesserungen daran durchgeführt werden können. Im Falle einer Änderung werden alle Nutzer der Freewave API rechtzeitig vorher davon 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. |
Eigenschaften eines Hotspots
Eine Anfrage an den Freewave API Server gibt, je nach Art, alle oder einige Hotspots mitsamt ihren Eigenschaften zurück. Dies sind die Eigenschaften:
| Eigenschaft |
Beschreibung |
Wert/Beispiel |
| uid |
UID des Hotspots. |
23200001 |
| name |
Name des Hotspots. |
Café Freewave |
| street1 |
Adresse des Standorts. |
Premlechnergasse 12 |
| street2 |
Zusatzinformationen zur Adresse. |
|
| postalCode |
Die Postleitzahl. |
1120 |
| country |
Das Lang nach ISO 3166-1-alpha-2. |
at |
| phone |
Die Telefonnummer des Standorts im internationalen Format. |
+4318040134 |
| email |
Die E-Mail Adresse des Standortes. |
office@freewave.at |
| url |
Die URL der Website des Standortes. |
http://www.freewave.at |
| latitude |
Die geographische Breite des Standortes. |
48.19559 |
| longitude |
Die geographische Länge des Standortes. |
16.35333 |
| coverage |
Die Abdeckung des WLAN Netzes. |
complete für den kompletten Standort. public-areas für öffentliche Bereiche wie z.B. eine Hotellobby. |
| logoSmall |
Die URL zu dem Logo des Standortes im kleinen Format (32x32 Pixel). Das Bild kann ein GIF, JPG oder PNG sein. |
http://static.freewave.at/logos/freewave_32.gif |
| logoMedium |
Die URL zu dem Logo des Standortes im mittleren Format (64x64 Pixel). Das Bild kann ein GIF, JPG oder PNG sein. |
http://static.freewave.at/logos/freewave_64.gif |
| logoLarge |
Die URL zu dem Logo des Standortes im großen Format (150x150 Pixel). Das Bild kann ein GIF, JPG oder PNG sein. |
http://static.freewave.at/logos/freewave_150.gif |
| status |
Der derzeitige Funktionsstatus des Hotspots.
Wird optional ausgegeben. |
on-air im Normalzustand, off-air bei temporären Ausfällen. |
| statusMessage |
Zusatzinformation zum Status.
Wird optional ausgegeben. |
z.B.: Leitungsstörung |
Anfragen
Die URI einer Anfrage an die Freewave API setzt sich aus folgenden Teilen zusammen:
http://api.freewave.at/hotspots/pfad.format?apikey=api-schlüssel[&weitere=parameter]
- Pfad: Es gibt mehrere Pfade, die unterschiedliche Ergebnisse ausgeben (siehe weiter unten).
- 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.
Alle Hotspots
| Beschreibung: |
Gibt alle Hotspots in einer Liste aus. |
| URI: |
http://api.freewave.at/hotspots.format |
| HTTP Methode: |
GET |
| Variablen: |
format
Das gewünschte Format (z.B.: xml). |
| Parameter: |
country (optional)
Das Land nach ISO 3166-1-alpha-2, z.B. at für Österreich. Die Liste wird damit auf dieses Land
beschränkt.
postcode (optional)
Die Postleitzahl, also z.B. 1120. Die Liste wird damit auf diese Postleitzahl beschränkt. Wird eine Postleitzahl aber kein Land angegeben, wird automatisch Österreich als Land gewählt.
status (optional)
Bei dem Wert yes werden auch jeweils die Status der Hotspots ausgegeben. |
| Beispielantwort |
|
Einzelner Hotspot
| Beschreibung: |
Gibt einen einzelnen Hotspot zurück. |
| URI: |
http://api.freewave.at/hotspots/uid.format |
| HTTP Methode: |
GET |
| Variablen: |
uid
Die eindeutige Identifikation des Hotspots (z.B.: 23200001).
format
Das gewünschte Format (z.B.: xml).
status (optional)
Bei dem Wert yes wird auch der Status des Hotspots ausgegeben. |
| Beispielantwort |
|
Status eines einzelnen Hotspots
| Beschreibung: |
Gibt den Status und die optinale Status-Message dazu eines einzelnen Hotspots zurück. |
| URI: |
http://api.freewave.at/hotspots/uid/status.format |
| HTTP Methode: |
GET |
| Variablen: |
uid
Die eindeutige Identifikation des Hotspots (z.B.: 23200001).
format
Das gewünschte Format (z.B.: xml). |
| Beispielantwort |
|
Neueste Hotspots
| Beschreibung: |
Gibt die x neuesten Hotspots aus. |
| URI: |
http://api.freewave.at/hotspots/latest.format |
| URI: |
http://api.freewave.at/hotspots/latest/anzahl.format |
| HTTP Methode: |
GET |
| Variablen: |
format
Das gewünschte Format (z.B.: xml).
anzahl
Die gewünschte Anzahl (z.B.: 20). |
| Parameter: |
country (optional)
Das Land nach ISO 3166-1-alpha-2, z.B. at für Österreich. Die Liste wird damit auf dieses Land
beschränkt.
postcode (optional)
Die Postleitzahl, also z.B. 1120. Die Liste wird damit auf diese Postleitzahl beschränkt. Wird eine Postleitzahl aber kein Land angegeben, wird automatisch Österreich als Land gewählt.
status (optional)
Bei dem Wert yes werden auch jeweils die Status der Hotspots ausgegeben. |
| Beispielantwort |
|
Änderungen seit einem Zeitpunkt
| Beschreibung: |
Gibt sämtliche Änderungen an der Hotspotliste seit einem bestimmten Zeitpunkt unterteilt in
added, updated und deleted zurück. Ideal um bestehende Listen zu aktualisieren. |
| URI: |
http://api.freewave.at/hotspots/since/datum.format |
| HTTP Methode: |
GET |
| Variablen: |
datum
Das Datum im W3C-Format, also z.B. 2009-04-08T14:00:00Z oder 2009-04-08T14:00:00+02:00.
format
Das gewünschte Format (z.B.: xml).
|
| Parameter: |
status (optional)
Bei dem Wert yes werden auch jeweils die Status der Hotspots ausgegeben. |
| Beispielantwort |
|
Hotspots in der Umgebung
| Beschreibung: |
Gibt Hotpots in der Umgebung der genannten Koordinaten zurück. |
| URI: |
http://api.freewave.at/hotspots/near/latitude+longitude.format |
| HTTP Methode: |
GET |
| Variablen: |
latitude
Die geographische Breite (z.B.: 48.19559).
longitude
Die geographische Länge (z.B.: 16.35333).
format
Das gewünschte Format (z.B.: xml).
status (optional)
Bei dem Wert yes werden auch jeweils die Status der Hotspots ausgegeben. |
| Parameter: |
metrics (optional, standardmäßig km)
Die gewünschte Einheit der Längenmaße. Erlaubte Werte: km für Kilometer, mi für Meilen.
radius (optional, standardmäßig 10)
Der Radius, in dem sich die Hotspots befinden dürfen. Bezieht sich auf metrics.
limit (optional)
Gibt die maximale Anzahl der ausgegebenen Hotspots an.
status (optional)
Bei dem Wert yes werden auch jeweils die Status der Hotspots ausgegeben. |
| Beispielantwort |
|
Web Hooks/Pings
Ein Highlight der Freewave API sind die optionalen Update-Pings nach dem Web Hooks Prinzip. Sobald Änderungen an der Hotspotliste durchgeführt werden, werden diese an eine von Ihnen definierte URL über einen einfachen POST-Request an Sie übergeben. Die neuen/geänderten Eigenschaften werden dabei als POST-Parameter mitgeschickt. Pro neuen, geänderten oder entfernten Hotspot wird ein Request durchgeführt.
Verwendete Parameter
| Parameter |
Beschreibung |
Wert/Beispiel |
| type |
Die Art des Pings. |
added, updated und deleted. |
| hash |
Ein Sicherheits-Hash, damit Sie sicher sein können, dass der Ping von Freewave kommt. Dieser Hash besteht aus einer mit MD5 verschlüsselten Zeichenfolge, die sich aus Ihrem API Schlüssel, dem Ping-Typ, der UID des gesendeten Hotspots und dem von Ihnen vorher definierten Shared Secret zusammensetzt. (Anmerkung: MD5 verschlüsselt Zeichen und keine Bits. Damit ist es in manchen Programmiersprachen wichtig, der Funktion keine Unicode-Zeichenfolgen zu übergeben.) |
35d64ce5c484911fd80ead34fbefd061 |
| ... |
Die restlichen Parameter entsprechen den Hotspot Eigenschaften. Bei updated-Pings, werden nur die geänderten Eigenschaften übergeben, bei deleted nur die UID. |
Siehe Eigenschaften eines Hotspots |
Referenzen
Comments (0)
You don't have permission to comment on this page.