KWICK! Community

kwick.me API

« zurück

Unsere API (Application Programming Interface) ermöglicht es Entwicklern für eigene Programme direkt auf unseren Dienst zu zugreifen, ohne die Webseite zu verwenden. Die Verwendung ist einfach und kostenlos. Unsere API liefert Daten im JSON Format.

Zur Verwendung der API benötigst Du einen API-Key, den Du per E-Mail beantragen kannst: api@kwick.me

API Dokumentation

Aufruf der API-Schnittstelle via GET-Parameter
URL: http://kwick.me/api.php URL der Schnittstelle
Parameter: String key API-Key
String url Zu verkürzende URL
Beispiel: http://kwick.me/api.php?key=1234567890&url=http://www.google.com

Antwort auf eine API-Anfrage
Parameter: String key Verkürzte URL ohne Prefix "http://kwick.me/"
String destination Ziel-URL
String url Verkürzte URL, z.B. http://kwick.me/123
Object status Status-Objekt gemäß nachfolgender Tabelle

Status-Objekt jeder API-Anfrage
Parameter: String result "OK" oder "ERROR"
Int code Statuscode gemäß Tabelle unten
String message Antwortmeldung in Klartext

Statuscodes
200 OK, Anfrage erfolgreich
400 Fehler, Parameter "url" fehlt
401 Fehler, Parameter "url" ist ungültig
403 Fehler, die URL wurde wegen Spam gesperrt
410 Fehler, Authentifizierung fehlgeschlagen
425 Fehler, Anzahl täglicher API-Abrufe überschritten
426 Fehler, API-Key existiert nicht oder ist ungültig
427 Fehler, API-Key wurde nicht übergeben (Parameter "key")
500 Interner Fehler, Dienst im Moment nicht verfügbar

Fragen? E-Mail an api@kwick.me

« zurück