serpstat sdk

serpstat/sdk

Serpstat API v3의 공식 SDK 라이브러리입니다.

시작하기

1단계: 인증 토큰 생성

API Serpstat는 사용자 토큰을 사용하여 요청을 인증합니다. 프로필 페이지에서 토큰을 생성할 수 있습니다.

2단계: 패키지 설치

명령 콘솔을 열고 프로젝트 디렉터리를 입력한 후 다음 명령을 실행하여 이 번들의 최신 안정 버전을 다운로드합니다.

$ composer require serpstat/sdk

이 명령을 사용하려면 Composer 설명서의 설치 장에 설명된 대로 Composer를 전역으로 설치해야 합니다.

3단계: 애플리케이션에 사용

 <?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 메소드 목록

수업	API 방법	설명
CheckLimits메서드	/통계	stats 명령을 사용하여 일일 한도 내에서 수행할 수 있는 요청 수를 확인할 수 있습니다.
도메인정보메서드	/도메인_정보	이 보고서는 SEO 및 PPC에서 도메인이 사용하는 키워드 수를 제공하고 온라인 가시성 및 기타 측정항목을 보여줍니다.
도메인 기록 방법	/도메인_역사	이 보고서는 도메인의 키워드 수 및 가시성에 대한 기록 데이터를 제공합니다.
도메인키워드방법	/도메인_키워드	이 보고서는 Google 상위 100개 검색 결과에서 해당 도메인의 키워드를 보여줍니다.
도메인 URL 메서드	/도메인_URL	분석된 도메인 내의 URL 목록을 반환합니다. 또한 각 URL에 대해 상위 100개의 키워드 수를 표시합니다.
도메인교차 방법	/도메인_교차로	최대 3개 도메인의 공통 키워드 표시
도메인Uniq키워드 방법	/domains_uniq_keywords	도메인의 고유 키워드를 표시합니다. 쿼리된 도메인이 하나 또는 두 개의 다른 도메인과 공통된 키워드는 목록에서 제거됩니다.
GetTopUrls메소드	/get_top_urls	도메인별 상위 URL을 표시합니다.
경쟁사 방식	/경쟁자	보고서에는 Google 상위 20개 결과에서 특정 키워드에 대해 순위가 매겨진 모든 도메인이 나열됩니다.
키워드방법	/키워드	이 방법은 전체 텍스트 검색을 사용하여 쿼리된 용어와 일치하는 모든 키워드를 찾습니다. 발견된 모든 키워드에 대해 해당 키워드의 양, CPC 및 경쟁 수준이 표시됩니다.
키워드정보방법	/키워드_정보	이 보고서는 볼륨, CPC 및 경쟁 수준을 보여주는 키워드 개요를 제공합니다.
제안방법	/제안	이 보고서에는 귀하가 요청한 키워드에 대한 자동 완성 제안이 나열되어 있습니다(전체 텍스트 검색을 통해 찾을 수 있음).
관련키워드방법	/관련_키워드	이 보고서는 SERP가 요청한 키워드의 SERP와 유사한 관련 키워드의 포괄적인 목록을 제공합니다(계정 유형 Standard 및 Professional에만 해당).
키워드Top메소드	/keyword_top	이 보고서는 귀하가 요청한 키워드에 대한 Google 상위 100개 자연 검색 결과를 보여줍니다.
광고 키워드 방법	/ad_키워드	이 보고서는 Google 유료 검색결과에서 검색된 키워드에 대해 팝업되는 광고 사본을 보여줍니다.
URL키워드방법	/url_키워드	보고서에는 Google 검색 결과에서 URL이 순위를 매기는 키워드가 나열되어 있습니다.
Url경쟁자 방법	/url_경쟁자	자연 검색에서 쿼리된 URL과 경쟁하는 URL 목록을 표시합니다.
URL 누락키워드메소드	/url_missing_keywords	경쟁사의 URL이 상위 10위 안에 들었지만 쿼리된 페이지에는 누락된 키워드 목록을 표시합니다.

SDK 예외

예외 클래스	암호	메시지
API예외	-	-
ApiInvalidRequestException	400	잘못된 요청
ApiLimitExceededException	402	관세 한도 초과
API액세스오류예외	403	인증 문제(잘못된 토큰, 금지된 작업 또는 사용자 차단)
APINoResults예외	404	결과 없음
ApiFrequencyExceededException	429	요청 빈도가 초과되었습니다(요청 간 시간 초과 증가).
API서버예외	500	서버 오류
InvalidParamException	500	잘못된 매개변수
ParseResponseException	500	응답을 구문 분석할 수 없습니다.