API Dokumentation

Mit einer API Schnittstelle können Sie die Daten aus unserem Tool in Ihren eigenen Tools verwenden und die Daten so aufbereiten, wie Sie es benötigen.

 

API Key erstellen / löschen

Um die API überhaupt nutzen zu können, brauchen Sie zunächst einen API Key. Dazu müssen Sie sich einloggen und anschließend navigieren Sie zu Einstellungen, ganz rechts, Pfeil runter bei dem Männchensymbol:

API Key finden

Anschließend können Sie ihn hier generieren lassen, indem Sie auf „API Key erstellen“ klicken:

API Key erstellen

Wenn Sie diesen nicht mehr benötigen, dann können Sie diesen auch wieder deaktivieren indem Sie auf „löschen“ klicken:

API Key delete

 

Folgende Befehle stehen Ihnen zur Verfügung:

 

getProjects

Mit „getProjects“ erhalten Sie die Projekte zurück, welche Sie bei sich im Account definiert hatten. Als Ergebnis wird die ProjektID, der Name und die URL samt URL ID zurückgegeben.

Beispiel der API Abfrage:

https://bakery.red-cookie.com/api/1.1/getProjects/apikey:<IhrAPIKey>

Beispiel einer Rückgabe:

[{„Project“:{„id“:“5″,“name“:“red-cookie.com“},“Url“:{„id“:“1″,“url“:“red-cookie.com“}}]

 

getKeywords

Mit „getKeywords“ erhalten Sie die gewünschten Suchbegriffe, die Sie bei sich in Ihrem Account für das jeweilige Projekt definiert, bzw. der Keywordgruppe hinzugefügt und mit dem Projekt verknüpft haben.

Die Abfrage setzt sich dabei wie folgt zusammen:

https://bakery.red-cookie.com/api/1.1/getKeywords//apikey:

Beispiel der API Abfrage:

https://bakery.red-cookie.com/api/1.1/getKeywords/5/apikey:<IhrAPIKey>

Die im Beispiel verwendete 5 ist eine ProjektID. Sie können also bei der Verwendung der API und der Abfrage nach den Keywords, welche einem Projekt zugeordnet sind, entweder nur ein Projekt oder mehrere durch ein Komma separiert abfragen lassen.

Beispiel einer Rückgabe:

[{„Project“:{„id“:“5″,“name“:“red-cookie.com“},“Keywordgroup“:[{„id“:“5″,“name“:“red-cookie.com“,“Keywords“:[{„Keyword“:{„id“:“11″,“name“:“keyword monitoring tool“}},{„Keyword“:{„id“:“166″,“name“:“red cookie“}}]}]}]

 

getRankings

Mit „getRankings“ erhalten sie die Rankings für ein bestimmtes Projekt für einen bestimmten Zeitraum oder mit Angabe von „all“ anstatt des Zeitraums, werden alle bis dahin gespeicherten Ergebnisse ausgegeben.

Die Abfrage setzt sich dabei wie folgt zusammen:

https://bakery.red-cookie.com/api/1.1/getRankings/<projectID>/<KeywordIDs oder all>/<<Beginnzeitpunkt im Format YYYY-MM-DD>/<Endezeitpunkt im Format YYYY-MM-DD>oder leer>/apikey:<IhrAPIKey>

Beispiel der API Abfrage:

https://bakery.red-cookie.com/api/1.1/getRankings/2/all/2015-04-22/2015-04-30/apikey:<IhrAPIKey>

Wenn Sie keinen Zeitraum angeben möchten und die Ergebnisse der letzten 7 Tage erhalten wollen, dann ist der nachfolgende Aufruf richtig:

https://bakery.red-cookie.com/api/1.1/getRankings/2/all/apikey:<IhrAPIKey>

Beispiel einer Rückgabe:

[{„Keywordcrawler“:{„rank“:“39″,“keyword_id“:“5″,“date“:“2015-04-22″}},{„Keywordcrawler“:{„rank“:“38″,“keyword_id“:“5″,“date“:“2015-04-23″}},{„Keywordcrawler“:{„rank“:“37″,“keyword_id“:“5″,“date“:“2015-04-24″}},{„Keywordcrawler“:{„rank“:“37″,“keyword_id“:“5″,“date“:“2015-04-25″}},{„Keywordcrawler“:{„rank“:“37″,“keyword_id“:“5″,“date“:“2015-04-26″}},{„Keywordcrawler“:{„rank“:“34″,“keyword_id“:“5″,“date“:“2015-04-27″}},{„Keywordcrawler“:{„rank“:“35″,“keyword_id“:“5″,“date“:“2015-04-28″}},{„Keywordcrawler“:{„rank“:“34″,“keyword_id“:“5″,“date“:“2015-04-29″}},{„Keywordcrawler“:{„rank“:“43″,“keyword_id“:“5″,“date“:“2015-04-30″}}]

 

Hinweis: Achten Sie darauf, dass HTTPS verwendet wird, da ansonsten Fehler auftreten könnten. Ebenfalls sollten Sie auf die richtige Schreibweise der Befehle achten, damit Ihre Abfragen richtig funktionieren.

Bei Fragen zur API oder Wünschen bzgl. weiteren  Befehlen können Sie sich jederzeit an unseren Support wenden. Hierzu am besten direkt über das Kundeninterface im Tool oder sollten Sie noch keinen Account haben, dann können Sie sich einen kostenlosen Account anlegen oder sich an uns wenden.

 

getCountries

Mit „getCountries“ ist es möglich, dass Sie die verschiedenen IDs der von uns unterstützten Länder abfragen. Dies ist notwendig, um später ein Keyword über die API anzulegen und diesem Suchbegriff ein Land zuzuordnen, in dem es gecrawlt werden soll.

Beispiel der API Abfrage:

https://bakery.red-cookie.com/api/1.1/getCountries/apikey:<IhrAPIKey>

Beispiel einer Rückgabe:

[{„Country“:{„id“:“1″,“name“:“Germany“}},{„Country“:{„id“:“2″,“name“:“Austria“}}]

 

getKeywordGroups

Mit „getKeywordGroups“ können die unterschiedlichen Keywordgruppen abgefragt werden, welche sich im Account befinden. Dies ist notwendig, um später ggf. auch entsprechend Keywords einer Keywordgruppe hinzuzufügen. Hierfür wird ein POST-Agent benötigt, z. B. Postman oder HTTP Requester, etc. Hier wird in der Adressezeile des Programm die URL der API samt Funktion eingegeben.

Beispiel:

https://bakery.red-cookie.com/api/1.1/getKeywordGroups/apikey:<IhrAPIKey>

Zusätzlich muss der Content im JSON Format übergeben werden

Beispiel:

[{„Keywordgroup“:{„id“:“2″,“name“:“hotels-regensburg“}}]

 

addKeywordGroups

Mit „addKeywordGroups“ ist es möglich, Keywordgruppen zu erstellen, welche nachher Keywords enthalten und Projekten zugeordnet werden sollen. Hierfür wird ein POST-Agent benötigt, z. B. Postman oder HTTP Requester, etc. Hier wird in der Adressezeile des Programm die URL der API samt Funktion eingegeben.

Beispiel:

https://bakery.red-cookie.com/api/1.1/addKeywordGroups/apikey:<IhrAPIKey>

Zusätzlich muss der Content im JSON Format übergeben werden. Es ist immer nur eines gleichzeitig möglich.

Beispiel:

[{„Keywordgroup“:{„name“:“Test“}}]

 

addKeywords

Mit „addKeywords“ ist es möglich, Keywords anzulegen und diese einer Keywordgruppe zuzuordnen sowie ein Land zuzuweisen, in dem es gecrawlt werden soll. Hierfür wird ein POST-Agent benötigt, z. B. Postman oder HTTP Requester, etc. Hier wird in der Adressezeile des Programm die URL der API samt Funktion eingegeben.

Beispiel:

https://bakery.red-cookie.com/api/1.1/addKeywords/apikey:<IhrAPIKey>

Zusätzlich muss der Content im JSON Format übergeben werden. Es ist immer nur eines gleichzeitig möglich.

Beispiel:

[{„Keyword“:{„name“:“test1″, „country_id“:1, „keywordgroup_id“: 23}}]

 

addProjects

Mit „addProjects“ können Projekte erstellt werden, wie es über die GUI möglich ist. Anschließend kann dem Projekt eine Keywordgruppe sowie die darin enthaltenen Keywords, zur Überpürfung, angelegt werden. Hierfür wird ein POST-Agent benötigt, z. B. Postman oder HTTP Requester, etc. Hier wird in der Adressezeile des Programm die URL der API samt Funktion eingegeben.

Beispiel:

https://bakery.red-cookie.com/api/1.1/addProjects/apikey:<IhrAPIKey>

Zusätzlich muss der Content im JSON Format übergeben werden. Es ist immer nur eines gleichzeitig möglich.

Beispiel:

[{„Project“:{„name“:“spiegel“, „url“:“spiegel.de“, „competitor“: „yes“, „keywordgroup_id“: 2}}]

 

APIv1

Wer die API in der Version 1.0 nutzt, der sollte auf die neue Version switchen. Hierfür muss lediglich die Version „1.0“ in „1.1“ ersetzt werden.

Facebooktwittergoogle_plusmail

Tägliches Keyword Monitoring und Recherche Tool