XML-RPC интерфейс SEOBudget

seobudget.getUserInfo() — получение информации о пользователе:

• идентификатор (int) id;
• дата регистрации (timestamp) reg_date;
• логин (string) login;
• имя пользователя (string) name;
• email (string) email;
• ICQ (string) icq;
• баланс, руб (double) balance;
• свободный для блокировки баланс (double) free_balance;
• WMZ-кошелек (string) wmz;
• WMR-кошелек (string) wmr;
• сумма к выплате, руб (double) need_to_payment;
• валюта для отображения сумм в заданиях (string) valute;
• используемый тарифный план (string) tarif;
• реферальная ссылка пользователя (string) referal_link;
• реферальные сайты пользователя (string) referal_sites;
• приглашенные пользователи (array) referal_list.

seobudget.getMoneyStat((timestamp) date_from, (timestamp) date_to) — статистика движения денежных средств по учетной записи. Возвращает многомерный массив данных, каждая позиция массива описывается следующими данными:

• номер операции (int) id;
• дата операции (timestamp) op_date;
• сумма операции со знаком, характеризующим приход или расход денежных средств, руб (double) op_sum;
• тип операции, возможные значения — ADMIN (баланс изменен администратором), USER (сумма баланса израсходована или пополнена пользователем), PARTNER (доходы по партнерской программе) (string) op_type.

seobudget.getOptions() — получение текущих настроек пользователя. Возвращается массив данных:

• извещать о завершенном анализе по электронной почте (bool) general_sendmail;
• получать ссылки на точно заданную страницу (bool) general_getlinks;
• не учитывать ссылки в теге noindex (bool) general_noindex;
• не учитывать ссылки с атрибутом nofollow (bool) general_nofollow;
• проверять наличие сайта в DMOZ (bool) general_dmoz;
• получать для сайтов значение Alexa Rank (bool) general_alexarank;
• определять возраст ссылающихся сайтов (bool) general_siteage;
• массив идентификаторов поисковых систем для сбора обратных ссылок (array) engines_inlinks;
• флаг использования стандартной формулы для оценки стоимости ссылки с главной страницы (bool) price_mainpagesimple;
• флаг использования собственной формулы для оценки стоимости ссылки с главной страницы (bool) price_mainpageother;
• биржа, по средним ценам которой будет осуществляться стандартная оценка стоимости ссылки с главной страницы (строковое значение из соответствующего списка бирж в веб-интерфейсе SEOBudget) (string) price_mainpagebroker;
• коэффициент для стандартной оценки стоимости ссылки с главной страницы (double) price_mainpagecoefficient;
• флаг учета количества внешних ссылок для стандартной формулы оценки стоимости сссылки с внутренней страницы (bool) price_maincalcbylinkcount;
• собственная формула пользователя для главных страниц (string) price_mainpageequation;
• флаг использования стандартной формулы для оценки стоимости ссылки с внутренней страницы (bool) price_innerpagesimple;
• флаг использования собственной формулы для оценки стоимости ссылки с внутренней страницы (bool) price_innerpageother;
• биржа, по средним ценам которой будет осуществляться стандартная оценка стоимости ссылки с внутренней страницы (строковое значение из соответствующего списка бирж в веб-интерфейсе SEOBudget) (string) price_innerpagebroker;
• коэффициент для стандартной оценки стоимости ссылки с внутренней страницы (bool) price_innerpagecoefficient;
• флаг учета количества внешних ссылок для стандартной формулы оценки стоимости сссылки с внутренней страницы (bool) price_innercalcbylinkcount;
• собственная формула пользователя для внутренних страниц (string) price_innerpageequation.

seobudget.setOptions((array) options) — изменение текущих настроек пользователя. В качестве параметра передается массив данных, аналогичный массиву данных функции seobudget.getOptions.

seobudget.getSearchEngines() — список поисковых систем, используемых для поиска ключевых фраз. Возвращается массив данных:

• идентификатор поисковой системы (int) id;
• название поисковой системы (string) name;
• массив с данными геотаргетинга (array) geo.

seobudget.getInlinkEngines() — список поисковых систем, используемых для поиска обратных ссылок. Возвращается массив данных:

• идентификатор поисковой системы (int) id;
• название поисковой системы (string) name.

seobudget.createSimpleTask((string) name, (string) type, (array) queries_sites [, (array) search_engines, (array) geo, (int) position, (array) geosetup]) — создание простого задания. Входные параметры:

• название задания (string) name;
• тип анализа (QUERIES — по списку запросов, SITES — по списку сайтов) (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]) — создание сложного задания. Входные параметры:

• название задания (string) name;
• массив запросов для анализа (queries);
• массив идентификаторов поисковых систем (array) search_engines;
• массив данных геотаргетинга для поисковых систем; ключ — идентификатор поисковой системы, значение — название региона (array) geo;
• тип анализа (EXACT — анализировать указанные сайты, AUTO — выбирать сайты автоматически по указанному критерию) (string) type;
• массив или целое число в зависимости от типа анализа — позиция (позиции) для анализа в поисковых системах (array / int) positions;
• флаг или целое число в зависимости от типа анализа — искать пересечения и ограничение на TOP соответственно (bool / int) cross_top;
• тип критерия — MAX или MIN, используется в случае автоматического выбора сайтов для анализа (string) min_max;
• название критерия, возможные значения — AGE, PR, CY, AR, YBL; используется в случае автоматического выбора сайтов для анализа (string) criteria;
• массив данных выдачи регионов для поисковых систем в случае анализа по списку запросов; ключ — идентификатор поисковой системы, значение — название региона (array) geosetup.

Возвращает идентификатор (int) id нового задания.

seobudget.getTasks((timestamp) date_from [, (timestamp) date_to = current, (bool) is_short = false]) — список заданий пользователя за указанный период (в полном или кратком виде согласно 3-му параметру). Возвращается массив данных, каждая позиция которого содержит:

• идентификатор задания (int) id;
• дата создания / выполнения задания (timestamp) cdate;
• статус задания, возможные значения OK, WAIT, ERROR, PROCESS (string) status;
• название задания (string) name;
• настройки пользователя для данного задания, в случае is_short = false (array) options;
• исходные данные по заданию, в случае is_short = false (array) initial;
• сводные результаты анализа в т.ч. по анализируемым сайтам (array) result;
• стоимость задания (double) price;
• описание задания (string) description.

seobudget.getTaskById((int) id_task [, (bool) is_short = false]) — сведения по конкретному заданию пользователя (в полном или кратком виде согласно 2-му параметру). Возвращаются данные следующего вида:

• идентификатор задания (int) id;
• дата создания / выполнения задания (timestamp) cdate;
• статус задания, возможные значения OK, WAIT, ERROR, PROCESS (string) status;
• название задания (string) name;
• настройки пользователя для данного задания, в случае is_short = false (array) options;
• исходные данные по заданию, в случае is_short = false (array) initial;
• сводные результаты анализа в т.ч. по анализируемым сайтам (array) result;
• стоимость задания (double) price;
• описание задания (string) description.

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) — создание задание инструмента. Входные параметры:

• идентификатор инструмента (string) id_tool, который может принимать значения:
  • positions — Определение позиций сайта
  • bindex — Проверка обратных ссылок
  • params — Определение показателей
  • unique — Проверка уникальности текстов
  • addurl — Добавление страниц в индекс
  • sindex — Проиндексированные страницы сайта
  • sitesperip — Сайты на IP-адресе
  • keywords — Подбор ключевых фраз
  • aggregator — Ссылочные бюджеты по агрегаторам
  • relevants — Подбор релевантных страниц
  • rival — Оценка конкурентности запросов по KEI
  • cms — Определение CMS сайта
• параметры инструмента (struct) parameters различные для каждого инструмента:
  • Определение позиций сайта
    • название анализа (string) taskname;
    • адрес сайта (string) siteurl;
    • фразы (array) qlist;
    • идентификаторы поисковых систем (array [ num => id_engine]) engines, где num — порядковый номер поисковой системы в задании, нужен для связи с полями geo и geosetup;
    • регионы сайта (array [ num => region ]) geo;
    • выдача региона (array [ num => region ]) geosetup;
    • глубина поиска (int) searchdeep;
    • период выполнения (string) period, может иметь значения: never, every_day, every_week, every_two_week, every_mounth, if_serp_update, if_yaca_update, if_cy_update.
  • Проверка обратных ссылок
    • название анализа (string) taskname;
    • список страниц (array) pageslist;
    • адрес сайта (string) siteurl;
    • что определять (tcy, pr, index, lindexgoogle, pgooglecachedate) (array) check;
    • вид проверяемой индексации в Яндекс (pindex, lindex, sindex), передаётся если check содержит index (string) yandexindextype;
    • период выполнения (string) period, может иметь значения: never, every_day, every_week, every_two_week, every_mounth, if_serp_update, if_yaca_update, if_cy_update.
  • Определение показателей
    • название анализа (string) taskname;
    • адреса страниц/сайтов (array) urllist;
    • вид проверяемой индексации (indexofpage (только в Яндекс), indexofsite) (string) indextype;
    • идентификатор поисковой системы, используется если indextype=indexofsite (int) engines;
    • что определять (tcy, pr, tpl) (array) check;
    • наличие в коде страницы строки, передаётся если check=tpl (string) tpl;
    • период выполнения (string) period, может иметь значения: never, every_day, every_week, every_two_week, every_mounth, if_serp_update, if_yaca_update, if_cy_update.
  • Проверка уникальности текстов
    • название анализа (string) taskname;
    • длина шингла (int) shinglen;
    • названия текстов (array) textname;
    • тексты (array) textcont;
    • не учитывать при поиске дубликатов следующие сайты (array) urllist.
  • Добавление страниц в индекс
    • название анализа (string) taskname;
    • список страниц (array) pageslist;
    • идентификаторы поисковых систем (array) engines.
  • Проиндексированные страницы сайта
    • название анализа (string) taskname;
    • адрес сайта (string) siteurl;
    • идентификаторы поисковых систем (array) engines;
    • глубина поиска (int) searchdeep;
    • получать значения Google PR (bool) getpr;
    • период выполнения (string) period, может иметь значения: never, every_day, every_week, every_two_week, every_mounth, if_serp_update, if_yaca_update, if_cy_update.
  • Сайты на IP-адресе
    • название анализа (string) taskname;
    • IP или имя сайта (string) ip;
    • Определять возраст домена (bool) age.
  • Подбор ключевых фраз
    • название анализа (string) taskname;
    • фразы (array) qlist;
    • идентификаторы поисковых систем, может быть только engines=array('13'), то есть Яндекс (array) engines;
    • регион сайта (string) geo13.
  • Ссылочные бюджеты по агрегаторам
    • название анализа (string) taskname;
    • адрес сайта (string) siteurl;
    • фразы (array) qlist;
    • идентификаторы агрегаторов (1 — WebEffector, 2 — Rookee, 3 — SeoPult) (array [ num => id_engine]) engines, где num — порядковый номер поисковой системы в задании, нужен для связи с полями geo;
    • регионы сайта (array [ num => region ]) geo.
  • Подбор релевантных страниц
    • название анализа (string) taskname;
    • адрес сайта, исп. в Определении позиций сайта (string) siteurl;
    • учитывать поддомены (bool) need_subdomains;
    • фразы (array) qlist;
    • идентификаторы поисковых систем (array [ num => id_engine]) engines, где num — порядковый номер поисковой системы в задании, нужен для связи с полями geo и geosetup;
    • регионы сайта (array [ num => region ]) geo;
    • выдача региона (array [ num => region ]) geosetup.
  • Оценка конкурентности запросов по KEI
    • название анализа (string) taskname;
    • фразы (array) qlist;
    • идентификаторы поисковых систем, может быть только одно значение (array [ num => id_engine]) engines, где num — порядковый номер поисковой системы в задании, нужен для связи с полями geo и geosetup;
    • регионы сайта (array [ num => region ]) geo;
    • выдача региона (array [ num => region ]) geosetup;
    • глубина поиска (int) searchdeep.
  • Определение CMS сайта
    • название анализа (string) taskname;
    • адреса сайтов (array) slist.

Возвращает идентификатор (int) id нового задания.

seobudget.changeToolTask((string) id_tool, (int) id_task, (struct) parameters) — редактирование задания инструмента. Работает только с инструментом «Определение позиций сайта» (id_tool = positions). Входные параметры:

• идентификатор инструмента (string) id_tool;
• идентификатор задания (int) id_task;
• параметры инструмента (struct) parameters, среди которых могут быть:
  • название анализа (string) taskname;
  • адрес сайта (string) siteurl;
  • фразы (array) qlist,
  • идентификаторы поисковых систем (array) engines;
  • регионы сайта (array [ id_engine => region ]) geo;
  • выдача региона (array [ id_engine => region ]) geosetup;
  • глубина поиска (int) searchdeep;
  • период выполнения (string) period, может иметь значения: never, every_day, every_week, every_two_week, every_mounth, if_serp_update, if_yaca_update, if_cy_update.

Возвращает идентификатор (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-му параметру). Возвращается массив данных, каждая позиция которого содержит:

• идентификатор задания (int) id;
• тип задания (string) id_tool;
• дата создания / выполнения задания (timestamp) cdate;
• статус задания, возможные значения OK, WAIT, ERROR, PROCESS (string) status;
• название задания (string) name;
• исходные данные по заданию, в случае is_short = false (array) initial;
• стоимость задания (double) price;
• описание задания (string) description.

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 задания инструмента данные в виде массива. Во второй переменной можно передать параметры фильтра результатов (все параметры необязательные):

• (int) date_from — дата начала выборки;
• (int) date_to — дата окончания выборки;
• (array) words — список фраз, по которым нужно вернуть результаты;
• (int) current_engine — порядковый id поисковой системы в результатах;
• (bool) is_only_position — возвращать ли только позицию фраз; возвращает массив, где ключи — фразы, а значения — позиции; если значение одно, то вернется только позиция;
• (bool) is_show_serp — возвращать ли список конкуретнов из ТОП; работает только если is_only_position = false.

При работе с инструментом "Определение позиций сайта", могут быть возвращены позиции вида: -1(сбор не удался и деньги не были списаны), 0(данный сайт с текущей глубиной поиска не был найден в выдаче), от 1 до 1000+(найденная позиция).

seobudget.getSearchEnginesUpdates() — список последних апдейтов поисковых систем (по три позиции на каждый тип апдейта). Возвращается многомерный массив данных, каждая позиция которого содержит

• тип апдейта (string) type;
• метку времени апдейта (timestamp) date;
• дату определения апдейта в читаемом формате (string) label.

Данные аналогичны данным соответствующего веб-сервиса.

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 копейки.