Als API (Abkürzung für Application Programming Interface) bezeichnet man eine Programmierschnittstelle. Dort werden also verschiedene Programme miteinander verbunden, sodass Daten zwischen diesen Systemen ausgetauscht werden können.
Um solch einen Datenaustausch gewähren und schützen zu können bedarf es Passwörtern. Diese werden als API Keys und Shared Secrets bezeichnet und dienen quasi als Login, um Unbefugten den Zugriff auf die Daten zu verweigern.
Mithilfe dieser Keys, werden Befehle, ausgehend von anderen Systemen, an die Searchmetrics Datenbank geben, damit diese die angefragten Informationen teilt.
Derzeit stehen Daten aus den folgenden Kategorien zur Verfügung:
- Organische Suche Rankings und Visibility
- Paid Search Rankings und Visibility
- Keywords
Für jeden Call werden API & Export Credits berechnet. Die exakten Kosten eines Calls werden in der Beschreibung des jeweiligen Calls angegeben. Calls die historische oder gefilterte Daten beinhalten sind meistens etwas teurer.
Eine Dokumentation aller Befehle (API Calls) finden Sie hier: Searchmetrics API Dokumentation
Inhalt
Einen API Key in der Searchmetrics Suite erstellen
Unter Einstellungen > API Keys > Übersicht können API Keys für verschiedenste Zwecke erstellt werden.
Klicken Sie dazu auf "Neuen API Key anlegen" in der rechten oberen Ecke. Im sich öffnenden Feld geben Sie dann den gewünschten Namen ein und wählen die Lizenz aus, in dem der Key liegen soll.
Die unten abgebildete Tabelle listet alle API Keys und jeweiligen Shared Secrets auf. Zusätzlich können hier die bereits genutzten und allgemein verfügbaren API Credits eingesehen werden. Schauen Sie sich den Lizenz Management Artikel an, um zu lernen, wie Ressourcen auf verschiedene Lizenzen verteilt werden können.
Empfehlung: Erstellen Sie für jede Sublizenz und Anwendung separate API Keys um den Zugang auf Daten regulieren und den Zugriff im Nachhinein auswerten zu können. Sie können bis zu 10 API Keys erstellen.
Den Access Token bekommen
Mithilfe des API Keys und des Shared Secrets lassen sich die Tokens generieren. Öffnen Sie zuerst eine Shell (z.B. Eingabeaufforderung (CMD) bei Windows / Terminal bei Apple).
Fügen Sie ihren API Key und die Shared Secret in die entsprechenden Lücken ein und entfernen Sie die "<" ">" Zeichen.
curl -u : https://api.searchmetrics.com/v4/token -d "grant_type=client_credentials"
In einem Skript fügen Sie die beiden Angaben folgender Maßen ein:
$api_key = '';
$api_secret = '';
$url = 'https://api.searchmetrics.com/v4/';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . 'token');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'grant_type=client_credentials');
curl_setopt($ch, CURLOPT_USERPWD, $api_key.':'.$api_secret);
$result = curl_exec($ch);
curl_close($ch);
$result = json_decode($result, true);
$access_token = $result['access_token'];
Anschließend erhalten Sie den Token im folgenden Feld:
{ "access_token": "", "expires_in": 3600, "token_type": "Bearer", "scope": null }
Dieser Token ist nun für 60 Min gültig und kann für API Calls genutzt werden.
Einen API Call machen
Schauen Wir uns ein Beispiel an. Wir wollen den Wert der weltweiten organischen SEO Visibility für searchmetrics.com wissen.
- Aus der Dokumentation entnehmen wir den Call: ResearchOrganicGetValueSeoVisibilityWorld
- Die Projekt ID finden Sie in der Adresszeile in der Searchmetrics Suite: project_id=xxxxxxx
- Die Sumaschinen ID finden Sie ebenfalls in der Dokumentation > Admin > Search Engines
- Den Token haben wir im vorherigen Schritt kreiert.
Nun haben wir alle Größen definiert und können den Call starten.
$project_id = <your_project_id>;
$se_id = <searchengine_id>;
$url = 'https://api.searchmetrics.com/v4/';
// Name of the call
$url .= 'ResearchOrganicGetValueSeoVisibilityWorld.json');
// Needed parameter
$url .= '?url=searchmetrics.com';
// Don't forget the token
$url .= '&access_token=<your_access_token>');
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, false);
$result = curl_exec($ch);
curl_close($ch);
$result = json_decode($result, true);
Das Ergebnis sollte im folgenden Format ausgegeben werden. Die weltweite SEO Visibility der gegebenen URL in unserem Beispiel liegt bei 2.085.245.
{ "sum": 2085245 }
Bei der Erstellung des Codes können Sie sich einfach unterstützen lassen. Wählen Sie dazu einen Call in unserer Dokumentation aus. Auf jeder Seite erfahren Sie im oberen Bereich die Kosten des jeweiligen Calls und die Parameter, die gebraucht werden. Der Token wird immer gebraucht.
Schauen wir uns auch dies wieder an einem Beispiel an: Wir wollen die Anzahl aller organischen Keywords für unsere Domain wissen. Wir suchen also unter Research Cloud > Organic und finden GetCountOrganicKeyword.
Auf dieser Seite erfahren wir, dass dieser Call 50 API Credits kostet. Und dass der Countrycode, sowie die URL gebraucht wird um den Call zu starten.
Weiter unten auf der Seite können die angeforderten Parameter in die Lücken eingesetzt werden. Klicken Sie anschließend auf "Send" und erhalten Sie die Response direkt auf dieser Seite.
>> Hier gehts zum kompletten Getting Started Guide in der Developer Dokumentation!