serpstat sdk

serpstat/sdk

这是 Serpstat API v3 的官方 SDK 库

入门

第 1 步：创建身份验证令牌

API Serpstat 使用用户令牌来验证请求。您可以在您的个人资料页面上创建一个令牌。

第 2 步：安装软件包

打开命令控制台，进入您的项目目录并执行以下命令以下载该捆绑包的最新稳定版本：

$ composer require serpstat/sdk

此命令要求您全局安装 Composer，如 Composer 文档的安装章节中所述。

第三步：应用中使用

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

SDK API方法列表

班级	接口方法	描述
检查限制方法	/统计数据	您可以使用命令 stats 检查您在每日限制内可以执行的请求数量
域信息方法	/域名信息	该报告为您提供 SEO 和 PPC 中使用的关键字域名数量，显示其在线可见度和其他指标。
领域历史方法	/域名历史记录	此报告为您提供有关域的关键字数量和可见性的历史数据。
域关键字方法	/域名关键字	此报告显示某个域在 Google 前 100 名搜索结果中排名的关键字。
域Urls方法	/域名网址	返回所分析域内的 URL 列表。还显示每个 URL 的前 100 个关键字的数量。
域交集法	/domains_intersection	显示最多 3 个域的常用关键字
域唯一关键字方法	/domains_uniq_keywords	显示域的唯一关键字。所查询的域与一两个其他域共有的关键字将从列表中删除。
获取TopUrls方法	/get_top_urls	按域显示热门网址。
竞争对手法	/竞争对手	该报告列出了在 Google 结果前 20 名中针对给定关键字排名的所有域
关键词方法	/关键词	该方法使用全文搜索来查找与查询词匹配的所有关键字。对于找到的每个关键字，您都会看到其数量、每次点击费用和竞争程度。
关键词信息方法	/关键字信息	该报告为您提供关键字概览，显示其数量、每次点击费用和竞争水平
建议方法	/建议	此报告列出了您请求的关键字的自动完成建议（通过全文搜索找到）。
相关关键词方法	/相关关键字	此报告为您提供了相关关键字的完整列表，其 SERP 与所请求的关键字相似（仅适用于帐户类型标准和专业）。
关键字顶部方法	/关键字顶部	此报告向您显示您所请求的关键字的 Google 前 100 个自然搜索结果。
广告关键词方法	/广告关键字	此报告向您显示在 Google 付费搜索结果中针对查询的关键字弹出的广告文案。
URL关键字方法	/url_关键字	该报告列出了 URL 在 Google 搜索结果中排名的关键字。
Url竞争对手方法	/url_竞争对手	显示与自然搜索中查询的 URL 竞争的 URL 列表。
网址缺失关键字方法	/url_missing_keywords	显示竞争对手网址排名前 10 名但在查询页面中缺失的关键字列表。

SDK异常

异常类	代码	信息
API异常	-	-
ApiInvalidRequestException	400	无效请求
ApiLimitExceededException 异常	第402章	超出关税限制
API访问错误异常	403	授权问题（错误的令牌、禁止的操作或用户被阻止）
ApiNoResultException	404	没有结果
ApiFrequencyExceededException	第429章	请求频率超出（增加请求之间的超时时间）
Api服务器异常	500	服务器错误
无效参数异常	500	无效参数
解析响应异常	500	无法解析响应