serpstat sdk

serpstat/sdk

Esta é a biblioteca oficial do SDK para a API Serpstat v3

Começando

Etapa 1: criar token de autenticação

A API Serpstat usa o token do usuário para autenticar solicitações. Você pode criar um token na sua página de perfil.

Etapa 2: Instale o pacote

Abra um console de comando, entre no diretório do seu projeto e execute o seguinte comando para baixar a versão estável mais recente deste pacote:

$ composer require serpstat/sdk

Este comando requer que você tenha o Composer instalado globalmente, conforme explicado no capítulo de instalação da documentação do Composer.

Etapa 3: usar no aplicativo

 <?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 ();
}

Lista de métodos da API SDK

Aula	Método API	Descrição
Método CheckLimits	/estatísticas	Você pode verificar o número de solicitações que pode realizar dentro do seu limite diário usando o comando stats
DomainInfoMethod	/domain_info	Este relatório fornece o número de palavras-chave que o domínio usa em SEO e PPC, mostra sua visibilidade online e outras métricas.
MétodoDomínioHistória	/domínio_histórico	Este relatório fornece dados históricos sobre o número de palavras-chave e a visibilidade de um domínio.
Método de palavras-chave de domínio	/domain_keywords	Este relatório mostra palavras-chave classificadas por um domínio nos 100 principais resultados de pesquisa do Google.
Método DomainUrls	/domain_urls	Retorna a lista de URLs do domínio analisado. Também mostra o número de palavras-chave das 100 principais para cada URL.
DomíniosIntersecçãoMétodo	/domínios_interseção	Mostra palavras-chave comuns de até 3 domínios
DomíniosUniqPalavras-chaveMétodo	/domínios_uniq_keywords	Mostra palavras-chave exclusivas de um domínio. As palavras-chave que o domínio consultado tem em comum com um ou dois outros domínios são removidas da lista.
Método GetTopUrls	/get_top_urls	Mostra os principais URLs por domínio.
Método dos Concorrentes	/concorrentes	O relatório lista todos os domínios classificados para determinada palavra-chave nos 20 principais resultados do Google
Método de palavras-chave	/palavras-chave	Este método usa uma pesquisa de texto completo para encontrar todas as palavras-chave que correspondem ao termo consultado. Para cada palavra-chave encontrada você verá seu volume, CPC e nível de concorrência.
KeywordInfoMethod	/keyword_info	Este relatório fornece uma visão geral das palavras-chave mostrando seu volume, CPC e nível de concorrência
Método de sugestões	/sugestões	Este relatório lista sugestões de preenchimento automático para a palavra-chave solicitada (elas são encontradas pela pesquisa de texto completo).
Método de palavras-chave relacionadas	/palavras-chave_relacionadas	Este relatório fornece uma lista abrangente de palavras-chave relacionadas cujo SERP é semelhante ao da palavra-chave solicitada (apenas para tipos de conta Padrão e Profissional).
KeywordTopMethod	/keyword_top	Este relatório mostra os 100 principais resultados de pesquisa orgânica do Google para a palavra-chave que você solicitou.
Método AdKeywords	/ad_keywords	Este relatório mostra cópias de anúncios que aparecem para a palavra-chave consultada nos resultados de pesquisa paga do Google.
UrlPalavras-chaveMétodo	/url_keywords	O relatório lista palavras-chave classificadas pelo URL nos resultados de pesquisa do Google.
UrlConcorrentesMétodo	/url_concorrentes	Mostra a lista de URLs que competem com um URL consultado na pesquisa orgânica.
UrlMissingKeywordsMethod	/url_missing_keywords	Mostra uma lista de palavras-chave classificadas pelos URLs dos concorrentes entre os 10 primeiros, mas que estão faltando na página consultada.

Exceções do SDK

Classe de exceção	Código	Mensagem
ApiException	-	-
ApiInvalidRequestException	400	Solicitação inválida
ApiLimitExceededException	402	Limites tarifários excedidos
ApiAccessErrorException	403	Problemas de autorização (token errado, ação proibida ou usuário bloqueado)
ApiNoResultsException	404	Nenhum resultado
ApiFrequencyExceededException	429	Frequência de solicitação excedida (aumentar o tempo limite entre solicitações)
ApiServerException	500	Erro no servidor
InvalidParamException	500	Parâmetro inválido
ParseResponseException	500	Não foi possível analisar a resposta