API-Dokumentation

Die API-Schnittstelle der SISTRIX Toolbox ermöglicht einen automatisierten, maschinengeeigneten Zugriff auf einen Großteil der Toolbox-Daten. Mit ihr integrierst Du die Toolbox im Handumdrehen in Deine internen Prozesse und Tools.

Die Toolbox-API ist in jedem Toolbox-Account enthalten. Die Nutzung bedarf keiner speziellen Pakete oder Optionen. Die verfügbaren Daten entsprechen den gebuchten Toolbox-Modulen. Auf dieser Seite werden generelle API-Informationen bereit gestellt. Der Abruf von Toolbox-Daten geschieht über Domain-, Keyword-, Link- und Optimizer-Methoden. Diese Methoden werden jeweils auf einer gesonderten Seite dokumentiert. Ebenso gibt es eine Seite für API-Rückgabecodes und Fehlermeldungen.

Anbindung an Microsoft Excel und Google Tabellen

Obwohl die SISTRIX API ursprünglich für die Nutzung mit Script- und Programmiersprachen entwickelt wurde, kann sie auch innerhalb von Microsoft Excel und Google Tabellen genutzt werden. An die Besonderheiten der Anbindung an diese beiden Lösungen gehen wir in zwei gesonderten Artikeln ein.

API-Authentifizierung

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:

https://de.sistrix.com/account/api

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 „100“. Um einen neuen API-Key zu erhalten, kontaktiere bitte unseren Support. Wir tauschen Deinen API-Key unkompliziert und schnell aus.

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. Sind bereits alle 5 Toolbox-Module gebucht und werden weitere API-Credits benötigt, können individuelle Vereinbarungen getroffen werden. Dafür bitte den Toolbox-Support kontaktieren. Über die API lassen sich auch die noch verbleibenden Credits abrufen:

https://api.sistrix.com/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 ist der Parameter „format“ mit dem Wert „json“ an jede URL anzuhängen.

https://api.sistrix.com/...?format=json

Länderauswahl

Sofern nicht explizit ein Land ausgewählt ist, so beziehen sich alle Rückgabewerte auf die Toolbox-Daten auf Deutschland. Andere Länder können durch Übergabe des „country“-Parameters ausgewählt werden.

Mögliche Werte des Country-Parameters: de, at, ch, it, es, fr, pl, nl, uk, us, se, br, tr

https://api.sistrix.com/...?country=$country

Erweiterte Datenbasis

API-Zugriffe erfolgen per Default auf die Standard-Datenbasis der Toolbox. Diese umfasst pro Land zwei Millionen Keywords – jeweils eine Millionen für Desktop-Ergebnisse und eine Millionen für Smartphone-Daten. In einigen Ländern bieten wir darüber hinaus eine erweiterte Datenbasis mit vielen Millionen Keywords an. Diese werden monatlich und nicht wöchentlich aktualisiert, sind dafür aber deutlich umfassender. Um über die API auf die erweiterte Datenbasis zuzugreifen, muss der Parameter „extended“ mit dem Wert „true“ gesetzt werden.

https://api.sistrix.com/...?extended=true

Smartphone-Daten

Zusätzlich zu den Desktop-Suchergebnissen ermittelt die Toolbox ebenfalls Ergebnisse für Suchen mit dem Smartphone. Um diese Ergebnisse über die API abzufragen, ist der Parameter „mobile“ mit dem Wert „true“ zu übergeben. Die erweiterte Datenbasis steht für Smartphone-Daten nicht zur Verfügung, eine Kombination mit „extended“ ist also nicht möglich.

https://api.sistrix.com/...?mobile=true