Проекты (устаревшая версия)
Актуальная версия API для получения списка проектов.
Эта версия перестанет поддерживаться 01.03.2018 года.
Актуальная версия API для работы с проектами (создание, удаление, копирование и др.).
Эта версия перестанет поддерживаться 01.01.2019 года.
Действие |
Параметры GET |
Параметры POST |
Ответ |
Получить список проектов |
&oper=get&module=mod_projects &func=v2 |
search_str |
Массив объектов проектов |
Создать проект |
&oper=add&module=mod_projects |
site, name, tags[] |
{result: id, message, error} |
Удалить проект |
&oper=del&module=mod_projects |
id |
{result: 0/1, message, error} |
Копировать проект |
&oper=add&module=mod_projects &func=duplicate |
project_id, copy_keywords, copy_history |
{result: 0/1, message, error} |
Перенести проект в архив/Восстановить проект из архива |
&oper=edit&module=mod_projects |
id, on |
{result: 0/1, message, error} |
Обновить данные о регистраторе домена
После обновления данных они будут доступны через метод "Получить список проектов"
Метод не работает с проектами, указывающими на определенную страницу сайта (например ролик youtube)
|
&oper=get&module=mod_projects &func=registrator_data |
project_id |
registrator_data
В ответе может вернуться параметр wait_time - в таком случае вызов метода неободимо повторить через некоторое время |
Описание параметров POST (функции редактирования):
- site – URL проекта;
- name – название проекта;
- tags[] – массив номеров тега (возможные номера: от 1 до 10)
- id – ID проекта;
- project_id – ID проекта;
- copy_keywords – копирование ядра:
- 0 - не копировать
- 1 - копировать
- copy_history – копирование истории проверок:
- 0 - не копировать
- 1 - копировать
- on – перенос в архив/восстановление из архива:
- -1 - перенести проект в архив
- 0 - восстановить проект из архива
Описание ответа (получить список проектов):
- id – id проекта;
- date – дата создания проекта;
- update – время последней проверки позиций;
- status – статус проверки:
- 0 - без статуса;
- 1 - проект поставлен в очередь;
- 2 - идет проверка позиций;
- update – время последней проверки позиций;
- update – время последней проверки позиций;
- subdomains – учитываются ли поддомены при проверке позиций:
- 0 - не учитываются;
- 1 - учитываются;
- on – расписание проверок:
- 0 - по требованию;
- 1 - по дням недели;
- 2 - после апдейтов Яндекса;
- 3 - один раз в месяц;
- 4 - по дням месяца;
- time_for_update – "|день|:час" при автоматической проверке;
- wait_after_updates – часы до автоматической проверки после апдейта;
- count_keywords – число активных запросов проекта;
- price – стоимость проверки проекта;
- email – e-mail владельца проекта;
- history – история статистики проекта за 2 последних дня;
- cy – тИЦ;
- indexed_y – количество страницх, проиндексированных в Yandex;
- indexed_g – количество страницх, проиндексированных в Google;
- traffic_y – трафик Yandex;
- traffic_g – трафик Google;
- backlinks – количество обратных ссылок;
- searchers – данные о добавленных ПС, краткая динамика по их поизциям по сравениню с предыдущей проверкой (массив объектов);
- registrator_data – данные о регистраторе доменной зоны;
- created – время регистрации (UTS);
- paidtill – оплачено до (UTS);
- registrar – наименование регистратора;
- registrar_link – ссылка не регистратора;
- registrar_price – стоимость домена;
- axelname_price – предлагаемая стоимость от регистратора Axelname;
Обратите внимание, что перед получением данных регистратора через этот метод сперва их нужно обновить, используя метод Обновить данные о регистраторе домена
Получение данных проекта с id XXX или по имени XXX:
https://api.topvisor.com/?api_key=ВАШ_КЛЮЧ&oper=get&module=mod_projects&func=v2&post[search_str]=XXX
Создать проект example.com с красной меткой:
https://api.topvisor.com/?api_key=ВАШ_КЛЮЧ&oper=add&module=mod_projects&post[site]=example.com
&post[name]=Название_проекта&post[tags][]=2
Удалить проект XXX:
https://api.topvisor.com/?api_key=ВАШ_КЛЮЧ&oper=del&module=mod_projects&post[id]=XXX
Копировать проект XXX с историей:
https://api.topvisor.com/?api_key=ВАШ_КЛЮЧ&oper=add&module=mod_projects&func=duplicate
&post[project_id]=XXX&post[copy_keywords]=1&post[copy_history]=1
Восстановить проект XXX из архива:
https://api.topvisor.com/?api_key=ВАШ_КЛЮЧ&oper=edit&module=mod_projects&post[id]=XXX&post[on]=0