Die API der SISTRIX Toolbox ermöglicht einen automatisierten Zugriff auf einen Großteil der Toolbox-Daten. Mit ihr integrierst du die Toolbox im Handumdrehen in deine internen Prozesse.
Die API ist in jedem Toolbox-Account ab dem „Plus“-Paket enthalten. Die verfügbaren Daten entsprechen dem gebuchten Paket. Das „Plus“-Paket beinhaltet nur den Zugriff auf den Sichtbarkeitsindex. Die Pakete „Professional“ und „Premium“ haben vollständigen Zugriff auf alle Funktionen.
Die einzelnen API-Methoden findest du in der Navigation auf der rechten Seite (am Smartphone ganz unten). Auf dieser Seite geht es um allgemeine Informationen zur API.
Die Daten, Funktionen & Ergebnisse dürfen ohne ausdrückliche, schriftliche Genehmigung nicht an Dritte weitergegeben werden.
Authentifizierung
Die Authentifizierung erfolgt durch Angabe deines API-Keys. Dieser API-Key kann in der Toolbox erstellt werden. Der API-Key muss bei allen Abfragen im Parameter „api_key“ übermittelt werden.
In der Toolbox kannst du mehrere API-Keys erstellen, diese benennen und auch wieder löschen. Auch findest du auf dieser Seite ein Logfile mit den letzten API-Aufrufen mit deinen API-Keys.
Credit-System
Für die Nutzung der API werden Credits vom Credit-Konto des Account abgezogen. Bei der Beschreibung der Methoden werden die Credit-Kosten aufgelistet. Das Credit-Konto wird in der Nacht von Sonntag auf Montag aufgefüllt.
Mit dem folgenden Aufruf kannst du die verbleibenden Credits deines Toolbox-Accounts über die API ermitteln.
https://api.sistrix.com/credits?api_key=[API_KEY]Ausgabeformat
Alle Anfragen und Rückgabewerte werden als UTF-8 geliefert. 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 jeden Aufruf anzuhängen.
https://api.sistrix.com/...?format=jsonLänderauswahl
Sofern nicht explizit ein Land gewählt wird, beziehen sich alle Rückgabewerte auf die Toolbox-Daten auf Deutschland. Andere Länder können durch Übergabe des country-Parameters ausgewählt werden. Es können alle verfügbaren Länder der Toolbox abgerufen werden.
https://api.sistrix.com/...?country=[COUNTRY_CODE]Mögliche Werte des Country-Parameters: de, at, ch, it, es, fr, pl, nl, uk, us, se, br, tr, be, ie, pt, dk, no, fi, gr, hu, sk, cz, au, jp, ca, ro, hr, bg, si
Desktop-Daten
Zusätzlich zu den Mobile-Suchergebnissen ermittelt die Toolbox ebenfalls Ergebnisse für Suchen mit dem Desktop. Um diese Ergebnisse über die API abzufragen, ist der Parameter mobile mit dem Wert false zu übergeben.
https://api.sistrix.com/...?mobile=falseRate-Limit
Die API ist je Toolbox-Account auf 300 Zugriffe je Minute begrenzt. Zwischen zwei Aufrufen sollten mindestens 300ms liegen. Werden diese Grenzen dauerhaft überschritten, antwortet die API mit dem Status-Code 429 (Too many requests), berechnet die Credits für diesen Aufruf aber nicht.
Fehler-Codes
Auch weitere Fehler sind möglich. Auf einer eigenen Seite findest du eine Auflistung aller möglichen Fehler-Codes inklusive ihrer jeweiligen Bedeutung.
