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	無法解析回應