serpstat sdk

serpstat/sdk

Il s'agit de la bibliothèque SDK officielle pour l'API Serpstat v3

Commencer

Étape 1 : Créer un jeton d'authentification

L'API Serpstat utilise le jeton utilisateur pour authentifier les demandes. Vous pouvez créer un jeton sur votre page de profil.

Étape 2 : installer le package

Ouvrez une console de commande, entrez le répertoire de votre projet et exécutez la commande suivante pour télécharger la dernière version stable de ce bundle :

$ composer require serpstat/sdk

Cette commande nécessite que Composer soit installé globalement, comme expliqué dans le chapitre d'installation de la documentation de Composer.

Étape 3 : Utilisation dans l'application

 <?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 des méthodes API du SDK

Classe	Méthode API	Description
Méthode CheckLimits	/statistiques	Vous pouvez vérifier le nombre de requêtes que vous pouvez effectuer dans votre limite quotidienne en utilisant la commande stats
MéthodeDomainInfo	/info_domaine	Ce rapport vous fournit le nombre de mots-clés utilisés par le domaine en SEO et PPC, montre sa visibilité en ligne et d'autres mesures.
Méthode Historique du Domaine	/historique_domaine	Ce rapport vous fournit des données historiques sur le nombre de mots-clés et la visibilité d'un domaine.
MéthodeDomainKeywords	/domain_keywords	Ce rapport affiche les mots-clés pour lesquels un domaine se classe dans les 100 premiers résultats de recherche de Google.
MéthodeDomaineUrls	/domain_urls	Renvoie la liste des URL dans le domaine analysé. Affiche également le nombre de mots-clés parmi les 100 premiers pour chaque URL.
MéthodeDomainsIntersection	/domaines_intersection	Affiche les mots-clés courants de jusqu'à 3 domaines
DomainesUniqKeywordsMéthode	/domains_uniq_keywords	Affiche les mots-clés uniques d'un domaine. Les mots clés que le domaine interrogé a en commun avec un ou deux autres domaines sont supprimés de la liste.
Méthode GetTopUrls	/get_top_urls	Affiche les principales URL par domaine.
Méthode des concurrents	/concurrents	Le rapport répertorie tous les domaines classés pour le mot-clé donné dans les 20 premiers résultats de Google.
Mots-clésMéthode	/mots-clés	Cette méthode utilise une recherche en texte intégral pour trouver tous les mots-clés correspondant au terme recherché. Pour chaque mot clé trouvé, vous verrez son volume, son CPC et son niveau de concurrence.
Mot-cléInfoMéthode	/mot_clé_info	Ce rapport vous fournit un aperçu des mots clés indiquant leur volume, leur CPC et leur niveau de concurrence.
SuggestionsMéthode	/suggestions	Ce rapport répertorie les suggestions de saisie semi-automatique pour le mot clé que vous avez demandé (elles sont trouvées par la recherche en texte intégral).
Méthode de mots-clés associés	/mots_clés_connexes	Ce rapport vous donne une liste complète de mots-clés associés dont le SERP est similaire à celui du mot-clé demandé (uniquement pour les types de compte Standard et Professionnel).
Mot-cléTopMethod	/mot-clé_top	Ce rapport vous montre les 100 meilleurs résultats de recherche organiques de Google pour le mot-clé que vous avez demandé.
Méthode AdKeywords	/ad_keywords	Ce rapport vous montre les copies d'annonces qui apparaissent pour le mot clé demandé dans les résultats de recherche payants de Google.
Méthode UrlKeywords	/url_mots-clés	Le rapport répertorie les mots-clés pour lesquels l'URL est classée dans les résultats de recherche Google.
Méthode UrlConcurrents	/url_concurrents	Affiche la liste des URL en concurrence avec une URL interrogée dans la recherche organique.
Méthode UrlMissingKeywords	/url_missing_keywords	Affiche une liste de mots-clés pour lesquels les URL des concurrents se classent dans le top 10 mais qui sont absents de la page interrogée.

Exceptions au SDK

Classe d'exceptions	Code	Message
APIException	-	-
ApiInvalidRequestException	400	Demande invalide
ApiLimitExceededException	402	Limites tarifaires dépassées
ApiAccessErrorException	403	Problèmes d'autorisation (mauvais jeton, action interdite ou utilisateur bloqué)
ApiNoResultsException	404	Aucun résultat
ApiFrequencyExceededException	429	Fréquence des requêtes dépassée (augmenter le délai d'attente entre les requêtes)
ApiServerException	500	Erreur de serveur
InvalidParamException	500	Paramètre invalide
ParseResponseException	500	Impossible d'analyser la réponse