serpstat sdk

serpstat/sdk

Dies ist die offizielle SDK-Bibliothek für die Serpstat API v3

Erste Schritte

Schritt 1: Authentifizierungstoken erstellen

API Serpstat verwendet das Benutzertoken zur Authentifizierung von Anfragen. Sie können auf Ihrer Profilseite ein Token erstellen.

Schritt 2: Installieren Sie das Paket

Öffnen Sie eine Befehlskonsole, geben Sie Ihr Projektverzeichnis ein und führen Sie den folgenden Befehl aus, um die neueste stabile Version dieses Bundles herunterzuladen:

$ composer require serpstat/sdk

Für diesen Befehl muss Composer global installiert sein, wie im Installationskapitel der Composer-Dokumentation erläutert.

Schritt 3: Verwendung in der Anwendung

 <?php
require_once __DIR__ . ' /../vendor/autoload.php ' ;

// configure your application
$ config = [
    ' token ' => ' 19666fc1ae1724da1d5ea2f3a99d5f5a ' ,
];

$ domain = ' example.com ' ;
$ keywords = ' keywords ' ;
$ url = ' http://example.com/page1/ ' ;

// init client with your serpstat api token
$ apiClient = new  Serpstat  Sdk  Core  ApiGuzzleHttpClient ( $ config [ ' token ' ]);

// create instance of any api method class
// e.g. DomainKeywordsMethod
// list of methods classes in folder srcMethods
$ apiMethod = new  Serpstat  Sdk  Methods  DomainKeywordsMethod (
    $ keywords , 
     Serpstat  Sdk  Interfaces  IApiClient :: SE_GOOGLE_RU
);

try {
    // try call api method
    $ response = $ apiClient -> call ( $ apiMethod );
} catch (  Exception $ e ) {
    // catch api error 
    $ response = $ e -> getMessage ();
}

Liste der SDK-API-Methoden

Klasse	API-Methode	Beschreibung
CheckLimitsMethod	/stats	Mithilfe der Befehlsstatistiken können Sie die Anzahl der Anfragen überprüfen, die Sie innerhalb Ihres Tageslimits ausführen können
DomainInfoMethod	/domain_info	Dieser Bericht liefert Ihnen die Anzahl der von der Domain in SEO und PPC verwendeten Schlüsselwörter, zeigt ihre Online-Sichtbarkeit und andere Kennzahlen.
DomainHistoryMethod	/domain_history	Dieser Bericht liefert Ihnen die historischen Daten zur Anzahl der Schlüsselwörter und zur Sichtbarkeit einer Domain.
DomainKeywordsMethod	/domain_keywords	Dieser Bericht zeigt Schlüsselwörter an, für die eine Domain in den Top-100-Suchergebnissen von Google rankt.
DomainUrlsMethod	/domain_urls	Gibt die Liste der URLs innerhalb der analysierten Domain zurück. Zeigt außerdem die Anzahl der Keywords aus den Top 100 für jede URL an.
DomainsIntersectionMethod	/domains_intersection	Zeigt häufige Schlüsselwörter von bis zu 3 Domains an
DomainsUniqKeywordsMethod	/domains_uniq_keywords	Zeigt eindeutige Schlüsselwörter einer Domain an. Schlüsselwörter, die die abgefragte Domain mit einer oder zwei anderen Domains gemeinsam hat, werden aus der Liste entfernt.
GetTopUrlsMethod	/get_top_urls	Zeigt Top-URLs nach Domain an.
KonkurrentenMethode	/Konkurrenten	Der Bericht listet alle Domains auf, die für das angegebene Keyword in den Top-20-Ergebnissen von Google ranken
SchlüsselwörterMethode	/Schlüsselwörter	Diese Methode verwendet eine Volltextsuche, um alle Schlüsselwörter zu finden, die mit dem abgefragten Begriff übereinstimmen. Für jedes gefundene Keyword sehen Sie Volumen, CPC und Konkurrenzniveau.
KeywordInfoMethod	/keyword_info	Dieser Bericht bietet Ihnen eine Keyword-Übersicht mit Angaben zu Volumen, CPC und Konkurrenzniveau
VorschlägeMethode	/Vorschläge	Dieser Bericht listet Autovervollständigungsvorschläge für das von Ihnen angeforderte Schlüsselwort auf (sie werden über die Volltextsuche gefunden).
RelatedKeywordsMethode	/verwandte_schlüsselwörter	Dieser Bericht bietet Ihnen eine umfassende Liste verwandter Keywords, deren SERP dem des angeforderten Keywords ähnelt (nur für die Kontotypen Standard und Professional).
KeywordTopMethod	/keyword_top	Dieser Bericht zeigt Ihnen die 100 besten organischen Suchergebnisse von Google für das von Ihnen angeforderte Keyword.
AdKeywords-Methode	/ad_keywords	Dieser Bericht zeigt Ihnen Anzeigenkopien, die für das abgefragte Keyword in den bezahlten Suchergebnissen von Google erscheinen.
URLKeywordsMethod	/url_keywords	Der Bericht listet Schlüsselwörter auf, für die die URL in den Google-Suchergebnissen rankt.
URLCompetitorsMethod	/url_competitors	Zeigt die Liste der URLs an, die in der organischen Suche mit einer abgefragten URL konkurrieren.
UrlMissingKeywordsMethod	/url_missing_keywords	Zeigt eine Liste von Schlüsselwörtern an, für die die URLs der Wettbewerber in den Top 10 ranken, die aber auf der abgefragten Seite fehlen.

SDK-Ausnahmen

Ausnahmeklasse	Code	Nachricht
ApiException	-	-
ApiInvalidRequestException	400	Ungültige Anfrage
ApiLimitExceededException	402	Tarifgrenzen überschritten
ApiAccessErrorException	403	Autorisierungsprobleme (falscher Token, verbotene Aktion oder Benutzer blockiert)
ApiNoResultsException	404	Keine Ergebnisse
ApiFrequencyExceededException	429	Anforderungshäufigkeit überschritten (Zeitüberschreitung zwischen Anforderungen erhöhen)
ApiServerException	500	Serverfehler
InvalidParamException	500	Ungültiger Parameter
ParseResponseException	500	Antwort kann nicht analysiert werden