Bitrix API

Yandex extends YandexBase implements IEngine

Table of Contents

Interfaces

IEngine

Constants

API_BASE_URL  = "https://api.webmaster.yandex.net/v3/user/"
API_HOSTS_URL  = "hosts/"
API_ORIGINAL_TEXTS_URL  = "original-texts/"
API_POPULAR_URL  = "search-queries/popular/"
API_SAMPLES_URL  = "links/external/samples/"
API_SUMMARY_URL  = "summary/"
API_VERIFICATION_URL  = "verification/"
ENGINE_ID  = 'yandex'
HOST_EXCLUDED  = "excluded-urls"
HOST_INDEXED  = "indexed-urls"
HOST_INFO  = "host-information"
HOST_ORIGINAL_TEXTS  = "original-texts"
HOST_TOP_QUERIES  = "top-queries"
HOST_VERIFY  = "verify-host"
HOSTS_SERVICE  = "host-list"
INDEXING_STATE_OK  = "OK"
ORIGINAL_TEXT_MAX_LENGTH  = 32000
ORIGINAL_TEXT_MIN_LENGTH  = 500
ORIGINAL_TEXT_SHOW_COUNT  = 50
QUERY_USER  = 'https://login.yandex.ru/info'
SERVICE_URL  = "https://webmaster.yandex.ru/api/v2"
VERIFIED_STATE_FAILED  = "VERIFICATION_FAILED"
VERIFIED_STATE_IN_PROGRESS  = "IN_PROGRESS"
VERIFIED_STATE_NEVER_VERIFIED  = "NEVER_VERIFIED"
VERIFIED_STATE_VERIFIED  = "VERIFIED"
VERIFIED_STATE_WAITING  = "WAITING"

Methods

__construct()  : mixed
addOriginalText()  : string
Send original text to webmaster
addSite()  : array<string|int, mixed>
Add site to webmaster. After adding you need verify rights at this site.
checkAuthExpired()  : mixed
clearSitesSettings()  : mixed
getAuth()  : mixed
getAuthSettings()  : mixed
getAuthUrl()  : string
Returns URL to authorize app
getCurrentUser()  : array<string|int, mixed>
Returns current Yandex user data
getFeeds()  : mixed
getInterface()  : CYandexOAuthInterface
Creates OAuth interface object instance
getOriginalTexts()  : mixed
getProxy()  : mixed
getSiteInfo()  : array<string|int, mixed>
Collect info about site by two different methods: info and statistic
getSiteInfoQueries()  : array<string|int, mixed>
Get info about popular queries for domain
getVerifySiteUin()  : UIN
Just checking verify status of site and get UIN for verification
setAuthSettings()  : mixed
verifySite()  : mixed

Constants

API_BASE_URL

public mixed API_BASE_URL = "https://api.webmaster.yandex.net/v3/user/"

API_HOSTS_URL

public mixed API_HOSTS_URL = "hosts/"

API_ORIGINAL_TEXTS_URL

public mixed API_ORIGINAL_TEXTS_URL = "original-texts/"

API_POPULAR_URL

public mixed API_POPULAR_URL = "search-queries/popular/"

API_SAMPLES_URL

public mixed API_SAMPLES_URL = "links/external/samples/"

API_SUMMARY_URL

public mixed API_SUMMARY_URL = "summary/"

API_VERIFICATION_URL

public mixed API_VERIFICATION_URL = "verification/"

ENGINE_ID

public mixed ENGINE_ID = 'yandex'

HOST_EXCLUDED

public mixed HOST_EXCLUDED = "excluded-urls"

HOST_INDEXED

public mixed HOST_INDEXED = "indexed-urls"

HOST_INFO

public mixed HOST_INFO = "host-information"

HOST_ORIGINAL_TEXTS

public mixed HOST_ORIGINAL_TEXTS = "original-texts"

HOST_TOP_QUERIES

public mixed HOST_TOP_QUERIES = "top-queries"

HOST_VERIFY

public mixed HOST_VERIFY = "verify-host"

HOSTS_SERVICE

public mixed HOSTS_SERVICE = "host-list"

INDEXING_STATE_OK

public mixed INDEXING_STATE_OK = "OK"

ORIGINAL_TEXT_MAX_LENGTH

public mixed ORIGINAL_TEXT_MAX_LENGTH = 32000

ORIGINAL_TEXT_MIN_LENGTH

public mixed ORIGINAL_TEXT_MIN_LENGTH = 500

ORIGINAL_TEXT_SHOW_COUNT

public mixed ORIGINAL_TEXT_SHOW_COUNT = 50

QUERY_USER

public mixed QUERY_USER = 'https://login.yandex.ru/info'

SERVICE_URL

public mixed SERVICE_URL = "https://webmaster.yandex.ru/api/v2"

VERIFIED_STATE_FAILED

public mixed VERIFIED_STATE_FAILED = "VERIFICATION_FAILED"

VERIFIED_STATE_IN_PROGRESS

public mixed VERIFIED_STATE_IN_PROGRESS = "IN_PROGRESS"

VERIFIED_STATE_NEVER_VERIFIED

public mixed VERIFIED_STATE_NEVER_VERIFIED = "NEVER_VERIFIED"

VERIFIED_STATE_VERIFIED

public mixed VERIFIED_STATE_VERIFIED = "VERIFIED"

VERIFIED_STATE_WAITING

public mixed VERIFIED_STATE_WAITING = "WAITING"

Methods

__construct()

public __construct() : mixed

addOriginalText()

Send original text to webmaster

public addOriginalText(mixed $text, mixed $domain) : string
Parameters
$text : mixed
$domain : mixed
Tags
throws
YandexException
Return values
string

addSite()

Add site to webmaster. After adding you need verify rights at this site.

public addSite(mixed $domain) : array<string|int, mixed>
Parameters
$domain : mixed
Tags
throws
YandexException
Return values
array<string|int, mixed>

checkAuthExpired()

public checkAuthExpired() : mixed

clearSitesSettings()

public clearSitesSettings() : mixed

getAuth()

public getAuth(mixed $code) : mixed
Parameters
$code : mixed

getAuthSettings()

public getAuthSettings() : mixed

getAuthUrl()

Returns URL to authorize app

public getAuthUrl() : string
Return values
string —

Url

getCurrentUser()

Returns current Yandex user data

public getCurrentUser() : array<string|int, mixed>
Tags
throws
SystemException
throws
YandexException
Return values
array<string|int, mixed>

getFeeds()

public getFeeds() : mixed

getInterface()

Creates OAuth interface object instance

public getInterface() : CYandexOAuthInterface
Return values
CYandexOAuthInterface

getOriginalTexts()

public getOriginalTexts(mixed $domain) : mixed
Parameters
$domain : mixed

getSiteInfo()

Collect info about site by two different methods: info and statistic

public getSiteInfo(mixed $domain) : array<string|int, mixed>
Parameters
$domain : mixed
Return values
array<string|int, mixed>

getSiteInfoQueries()

Get info about popular queries for domain

public getSiteInfoQueries(mixed $domain) : array<string|int, mixed>
Parameters
$domain : mixed
  • URL of domain
Tags
throws
YandexException
Return values
array<string|int, mixed>

getVerifySiteUin()

Just checking verify status of site and get UIN for verification

public getVerifySiteUin(mixed $domain) : UIN
Parameters
$domain : mixed
Tags
throws
YandexException
Return values
UIN —

if site not verified and FALSE if site already verify.

setAuthSettings()

public setAuthSettings([mixed $settings = null ]) : mixed
Parameters
$settings : mixed = null

verifySite()

public verifySite(mixed $domain[, mixed $verType = 'HTML_FILE' ]) : mixed
Parameters
$domain : mixed
$verType : mixed = 'HTML_FILE' 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results