serpstat sdk

serpstat/sdk

Esta es la biblioteca SDK oficial para Serpstat API v3

Empezando

Paso 1: crear un token de autenticación

API Serpstat utiliza el token de usuario para autenticar solicitudes. Puede crear un token en su página de perfil.

Paso 2: instale el paquete

Abra una consola de comandos, ingrese al directorio de su proyecto y ejecute el siguiente comando para descargar la última versión estable de este paquete:

$ composer require serpstat/sdk

Este comando requiere que Composer esté instalado globalmente, como se explica en el capítulo de instalación de la documentación de Composer.

Paso 3: uso en la aplicación

 <?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 API del SDK

Clase	Método API	Descripción
Método CheckLimits	/estadísticas	Puede verificar la cantidad de solicitudes que puede realizar dentro de su límite diario usando el comando estadísticas
Método de información de dominio	/información_dominio	Este informe le proporciona la cantidad de palabras clave utilizadas por el dominio en SEO y PPC, muestra su visibilidad en línea y otras métricas.
DominioHistorialMétodo	/historia_dominio	Este informe le proporciona datos históricos sobre la cantidad de palabras clave y la visibilidad de un dominio.
DominioPalabras claveMétodo	/palabras_clave_dominio	Este informe muestra las palabras clave que clasifica un dominio en los 100 principales resultados de búsqueda de Google.
DominioUrlsMétodo	/URL_dominio	Devuelve la lista de URL dentro del dominio analizado. También muestra la cantidad de palabras clave del top 100 para cada URL.
DominiosIntersecciónMétodo	/intersección_dominios	Muestra palabras clave comunes de hasta 3 dominios.
DominiosUniqPalabras claveMétodo	/dominios_uniq_palabras clave	Muestra palabras clave únicas de un dominio. Las palabras clave que el dominio consultado tiene en común con uno o dos dominios más se eliminan de la lista.
Método GetTopUrls	/get_top_urls	Muestra las URL principales por dominio.
CompetidoresMétodo	/competidores	El informe enumera todos los dominios que se clasifican para la palabra clave determinada en los 20 resultados principales de Google.
Palabras claveMétodo	/palabras clave	Este método utiliza una búsqueda de texto completo para encontrar todas las palabras clave que coincidan con el término consultado. Por cada palabra clave encontrada verás su volumen, CPC y nivel de competencia.
Método de información de palabras clave	/info_palabra clave	Este informe le proporciona una descripción general de las palabras clave que muestra su volumen, CPC y nivel de competencia.
SugerenciasMétodo	/sugerencias	Este informe enumera sugerencias de autocompletar para la palabra clave que solicitó (se encuentran mediante la búsqueda de texto completo).
Palabras clave relacionadasMétodo	/palabras_clave_relacionadas	Este informe le brinda una lista completa de palabras clave relacionadas cuyo SERP es similar al que tiene la palabra clave solicitada (solo para los tipos de cuenta Estándar y Profesional).
Palabra claveTopMétodo	/palabra clave_arriba	Este informe le muestra los 100 mejores resultados de búsqueda orgánica de Google para la palabra clave que solicitó.
Método de palabras clave de anuncios	/palabras_clave_anuncios	Este informe le muestra copias de anuncios que aparecen para la palabra clave consultada en los resultados de búsqueda paga de Google.
URLPalabras claveMétodo	/url_palabras clave	El informe enumera las palabras clave que clasifican las URL en los resultados de búsqueda de Google.
UrlCompetidoresMétodo	/url_competidores	Muestra la lista de URL que compiten con una URL consultada en la búsqueda orgánica.
UrlPalabras clave faltantesMétodo	/url_palabras_clave_faltantes	Muestra una lista de palabras clave para las que las URL de la competencia se clasifican entre las 10 primeras pero que no aparecen en la página consultada.

Excepciones del SDK

Clase de excepción	Código	Mensaje
ApiExcepción	-	-
Excepción de solicitud inválida de API	400	Solicitud no válida
ApiLimitExceededException	402	Límites arancelarios excedidos
ApiAccessErrorExcepción	403	Problemas de autorización (token incorrecto, acción prohibida o usuario bloqueado)
ApiNoResultsException	404	Sin resultados
ApiFrequencyExceededException	429	Se superó la frecuencia de solicitud (aumentar el tiempo de espera entre solicitudes)
ApiServerException	500	error del servidor
Excepción de parámetro no válido	500	Parámetro no válido
Excepción de respuesta de análisis	500	No se puede analizar la respuesta