XML-RPC интерфейс сервиса SEOBudget доступен по адресу http://seobudget.ru/api/.
Обращаться необходимо на 80-й порт, а «тело» XML-запроса класть в POST_DATA. См. также реализации XML-RPC протокола для различных языков программирования.
Для языка PHP мы рекомендуем вот эту библиотеку.
Все строковые данные при работе с интерфейсом указываются и возращаются в кодировке UTF-8.
seobudget.login((string) login, (string) password) — авторизация в системе, функцию необходимо вызывать в начале каждой сессии. Далее при каждом следующем запросе нужно передавать все вернувшиеся cookie.
Функции, отвечающие за настройки аккаунта пользователя и данные о средствах.
seobudget.getUserInfo() — получение информации о пользователе:
seobudget.getMoneyStat((timestamp) date_from, (timestamp) date_to) — статистика движения денежных средств по учетной записи. Возвращает многомерный массив данных, каждая позиция массива описывается следующими данными:
seobudget.getOptions() — получение текущих настроек пользователя. Возвращается массив данных:
seobudget.setOptions((array) options) — изменение текущих настроек пользователя. В качестве параметра передается массив данных, аналогичный массиву данных функции seobudget.getOptions.
Функции, возвращающие списки поисковых систем, используемых для определения различных параметров.
seobudget.getSearchEngines() — список поисковых систем, используемых для поиска ключевых фраз. Возвращается массив данных:
seobudget.getInlinkEngines() — список поисковых систем, используемых для поиска обратных ссылок. Возвращается массив данных:
Функции для работы с простым анализом и расширенным анализом. Внимание! Для работы с инструментами, например с определением позиций сайта, используются функции из раздела Платные инструменты.
Просмотреть список функций для работы с анализами
seobudget.createSimpleTask((string) name, (string) type, (array) queries_sites [, (array) search_engines, (array) geo, (int) position, (array) geosetup]) — создание простого задания. Входные параметры:
Возвращает идентификатор (int) id нового задания.
seobudget.createAdvancedTask((string) name, (array) queries, (array) search_engines, (array) geo, (string) type, (array / int) positions, (bool / int) cross_top [, (string) min_max, (string) criteria, (array) geosetup]) — создание сложного задания. Входные параметры:
Возвращает идентификатор (int) id нового задания.
seobudget.getTasks((timestamp) date_from [, (timestamp) date_to = current, (bool) is_short = false]) — список заданий пользователя за указанный период (в полном или кратком виде согласно 3-му параметру). Возвращается массив данных, каждая позиция которого содержит:
seobudget.getTaskById((int) id_task [, (bool) is_short = false]) — сведения по конкретному заданию пользователя (в полном или кратком виде согласно 2-му параметру). Возвращаются данные следующего вида:
seobudget.getTaskSiteData((int) id_task, (string) site) — возвращает по указанному сайту и заданию данные в формате CS Yazzle, закодированные по алгоритму BASE64. Параметр site — соответствующий ключ массива result функции seobudget.getTasks.
seobudget.deleteTask((int) id_task) — удаляет задание пользователя. Возвращается true или false. Удалить можно только задания, которые не находятся в процессе выполнения.
Функции для работы с платными инструментами. Внимание! Для работы с простым анализом и расширенным анализом, используются функции из раздела Оценка бюджетов.
Просмотреть список функций для работы с инструментами
seobudget.createToolTask((string) id_tool, (struct) parameters) — создание задание инструмента. Входные параметры:
Возвращает идентификатор (int) id нового задания.
seobudget.changeToolTask((string) id_tool, (int) id_task, (struct) parameters) — редактирование задания инструмента. Работает только с инструментом «Определение позиций сайта» (id_tool = positions). Входные параметры:
Возвращает идентификатор (int) id отредактированного задания.
seobudget.restartToolTask((int) id_task) — перезапускает задание инструмента пользователя. Возвращается true или false. Перезапустить можно только задания, которые не находятся в процессе выполнения.
seobudget.deleteToolTask((int) id_task) — удаляет задание инструмента пользователя. Возвращается true или false. Удалить можно только задания, которые не находятся в процессе выполнения.
seobudget.getToolTasks((timestamp) date_from [, (timestamp) date_to = current, (bool) is_short = false, (string) id_tool = '']) — список заданий пользователя за указанный период (в полном или кратком виде согласно 3-му параметру). Возвращается массив данных, каждая позиция которого содержит:
seobudget.getToolResult((int) id_task, (boolean) is_zlib [, (boolean) only_date = false]) — возвращает по указанному ID задания инструмента данные в формате XML, закодированные по алгоритму BASE64. Если вторым параметром указано true, то данные вернутся в сжатом виде (алгоритм ZLIB). Если only_date = true, то возвращается только дата последнего выполнения задания. Функция возвращает данные за последние 10 запусков инструмента (в случае позиций - 10 последних сборов).
seobudget.getToolResultByParams((int) id_task[, (struct) parameters]) — возвращает по указанному ID задания инструмента данные в виде массива. Во второй переменной можно передать параметры фильтра результатов (все параметры необязательные):
При работе с инструментом "Определение позиций сайта", могут быть возвращены позиции вида: -1(сбор не удался и деньги не были списаны), 0(данный сайт с текущей глубиной поиска не был найден в выдаче), от 1 до 1000+(найденная позиция).
Функции для работы с бесплатными инструментами, такими как Точные апдейты Яндекса и Google и Зеркала сайтов в домене RU.
Просмотреть список функций для работы с бесплатными инструментами
seobudget.getSearchEnginesUpdates() — список последних апдейтов поисковых систем (по три позиции на каждый тип апдейта). Возвращается многомерный массив данных, каждая позиция которого содержит
Данные аналогичны данным соответствующего веб-сервиса.
seobudget.getSiteMirrors((string) domain) — возвращает список зеркал для заданного сайта. Данные аналогичны данным соответствующего веб-сервиса.
Функции для быстрых проверок различных парамеров, таких как индексация страниц, ссылок и сайтов и геозависимость запросов.
Просмотреть список функций для быстрых проверок
seobudget.checkLinkIndex((array) urls, (array) anchors) — проверка индексации ссылок, не более 15 ссылок за 1 запрос. Параметр urls — массив страниц-доноров, anchors — массив анкоров ссылок на страницах-донорах. Возвращает целое число — 0 (не в индексе), -1 (ошибка обработки) или 1 (в индексе). Внимание! За проверку индексации одной ссылки с баланса списывается 6 копеек. На вашем балансе должно быть не менее 50 рублей. В противном случае функция вернет ошибку.
seobudget.checkPageIndex((array) urls) — проверка индексации страниц-доноров, не более 15 страниц за 1 запрос. Параметр urls — массив страниц-доноров. Возвращает целое число — 0 (не в индексе), -1 (ошибка обработки) или 1 (в индексе). Внимание! За проверку индексации одной страницы с баланса списывается 6 копеек. На вашем балансе должно быть не менее 50 рублей. В противном случае функция вернет ошибку.
seobudget.checkSiteIndex((array) domains) — проверка индексации сайтов, не более 15 доменов за 1 запрос. Параметр domains — массив доменов. Возвращает — 0 (не в индексе), -1 (ошибка обработки) или число страниц в индексе. Внимание! За проверку индексации одного сайта с баланса списывается 6 копеек. На вашем балансе должно быть не менее 50 рублей. В противном случае функция вернет ошибку.
seobudget.checkGeoDependence((array) queries) — проверка геозависимости запросов, не более 15 за 1 вызов функции. Параметр queries — массив запросов. Возвращает — 0 (не геозависимый), -1 (ошибка обработки) или 1 (геозависимый). Внимание! За проверку геозависимости одного запроса с баланса списывается 6 копеек. На вашем балансе должно быть не менее 50 рублей. В противном случае функция вернет ошибку.
seobudget.getSiteIndexHistory((string) domain) — история индексации сайта в Яндексе. Параметр domain — домен сайта. Возвращает — массив, где status — статус успешен ответ или нет, result — массив вида «дата — количество страниц в индексе». Внимание! За проверку истории индексации одного сайта с баланса списывается 3 копейки.