API-Key
Die Authentifizierung erfolgt durch Übermittlung eines API-Keys. Dieser Key kann auf folgender Seite beantragt werden und wird in der Regel innerhalb kurzer Zeit erzeugt:
Der API-Key muss bei allen Abfragen im Parameter “api_key” übermittelt werden. Geschieht dieses nicht oder wird ein ungültiger API-Key verwendet, meldet die API den Fehlercode “001″.
Credit-System
Für die Nutzung der API werden, je nach Abfrage, Credits vom Credit-Konto des Account abgezogen. Bei der Beschreibung der Methoden werden die jeweiligen Credit-Kosten aufgelistet. Das Credit-Konto wird jeweils in der Nacht von Sonntag auf Montag wieder aufgefüllt. Pro abonniertem Toolbox-Modul werden dem Credit-Konto 10.000 Credits gutgeschrieben. Eine Übernahme nicht genutzter Credits aus der Vorwoche findet nicht statt.
Über die API lassen sich auch die noch verbleibenden Credits ausgeben:
http://api.sistrix.net/credits?api_key=$key
Ausgabeformat
Alle Anfragen und Rückgabewerte sind UTF-8 kodiert.
Standardmäßig erfolgt die Rückgabe der API-Schnittstelle im XML-Format. Alternativ kann auf eine Json-Rückgabe umgestellt werden. Dafür den Parameter “format” mit dem Wert “json” an jede URL anhängen.
http://api.sistrix.net/xzy?format=json
Länderauswahl
Sofern nicht explizit ein Land ausgewählt ist, so beziehen sich alle Rückgabewerte auf die Toolbox-Daten für Deutschland. Weitere Länder können durch Übergabe des “country”-Parameters ausgewählt werden.
http://api.sistrix.net/xzy?country=$country
Mögliche Werte:
- de – Deutschland
- at – Österreich
- ch – Schweiz
- us – USA
- uk – England
- es – Spanien
- fr – Frankreich
- it – Italien
