API Dokumentation

Um auf die API zugreifen zu können wird ein API Key benötigt. Dieser kann über eine Email an mail@sim4000.de beantragt werden. Bitte beschreibe kurz was Du mit der API vor hast. Bitte beachte das jeder Link der in der Datenbank steht mit dem API Key in Verbindung gebracht werden kann. Gibst Du den Key zum Beispiel über ein Programm weiter und es wird damit Quatsch gemacht, wird der API Key gesperrt!

Allgemeine Funktionsweise

Mit der API wird über simple HTTP Anfragen kommuniziert. Alle Daten werden über ein POST Request an die API gesendet. Die API sendet dann XML oder JSON als Antwort. Die Antwort enhält alle nötigen Informationen um auf erfolgreiche und fehlgeschlagene Anfragen zu reagieren.

Extensible Markup Language

Die Extensible Markup Language abgekürzt XML, ist eine Auszeichnungssprache zur Darstellung hierarchisch strukturierter Daten in Form von Textdaten. XML wird u. a. für den plattform- und implementationsunabhängigen Austausch von Daten zwischen Computersystemen eingesetzt, über das Internet insbesondere.
Quelle: Wikipedia

JavaScript Object Notation

Die JavaScript Object Notation, kurz JSON, ist ein kompaktes Datenformat in für Mensch und Maschine einfach lesbarer Textform zum Zweck des Datenaustauschs zwischen Anwendungen. Obwohl der Name auf eine alleinige Verwendung in JavaScript hindeutet, ist JSON ein unabhängiges Format, welches theoretisch in jeder Programmiersprache eingesetzt werden kann. Quelle: Wikipedia

Verfügbare Abfragen

http://üäx.de/api/32 Zeichen API Key/Ausgabetyp/Aktion/

Einen neuen Link hinzufügen

Link: http://üäx.de/api/e583af1f8b00b53cda87ae9ead880224/xml/add/
POST Daten: url=http://example.com

Antwort:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
   <error_code>no_error</error_code>
   <error_message></error_message>
   <request_date>Mon, 07 Jun 2010 21:22:57 +0200</request_date>
   <url>http://example.com</url>
   <url_code>1c</url_code>
   <short_url>http://üäx.de/1c</short_url>
</response>

Einen Link löschen

Funktioniert nur bei Links die auch selbst angelegt wurden!
Link: http://üäx.de/api/e583af1f8b00b53cda87ae9ead880224/xml/delete/
POST Daten (mit URL): url=http://example.com
POST Daten (mit Code): url_code=1c

Antwort:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
   <error_code>no_error</error_code>
   <error_message></error_message>
   <request_date>Mon, 07 Jun 2010 21:34:19 +0200</request_date>
   <url>http://example.com</url>
   <url_code>1c</url_code>
   <short_url>http://üäx.de/1c</short_url>
</response>

Den Originallink ermitteln

Link: http://üäx.de/api/e583af1f8b00b53cda87ae9ead880224/xml/get/
POST Daten: url_code=1c

Antwort:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
   <error_code>no_error</error_code>
   <error_message></error_message>
   <request_date>Mon, 07 Jun 2010 21:43:59 +0200</request_date>
   <url>http://example.com</url>
   <url_code>1c</url_code>
   <short_url>http://üäx.de/1c</short_url>
</response>

Mögliche Fehlermeldungen

Fehlercode	Beschreibung
unknown_action	Die API wurde nicht korrekt aufgerufen. Die übergebene Aktion wird nicht unterstützt.
url_error	Die übergebene URL ist ungültig!
urlcode_error	Der URL Code ist ungültig
add_error	Unerwarteter Fehler beim Hinzufügen einer URL
too_many_requests	Zu viele Anfragen auf einmal. Es sind höchstens 10 Anfragen pro Minute erlaubt. Dies kann je nach API Key abweichend konfiguriert sein.
code_not_found	Der URL Code konnte nicht in der Datenbank gefunden werden!
delete_not_allowed	Es wurde versucht einen Link zu löschen, den man nicht selbst angelegt hat.
url_not_found	Die URL wurde nicht in der Datenbank gefunden!
unknown_call	Die API wurde nicht korrekt aufgerufen.

---

by Christian Blechert - Impressum - Hosted by netcup