Freewave API Dokumentation
Beta
Bitte beachten Sie, dass sich die Freewave API derzeit im Beta Stadium befindet und noch Änderungen durchgeführt werden können. Im Falle einer Änderung werden alle Nutzer der Freewave API vorher Informiert.
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 anfragende Applikation identifiziert. Kontaktieren Sie uns, um einen API Schlüssel für Ihre Applikation zu erhalten.
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>
Comments (0)
You don't have permission to comment on this page.