Содержание
Дополнительные аккаунты
Просмотр дополнительных аккаунтов пользователя
Описание
Метод позволяет получить список всех дополнительных аккаунтов пользователя.
Формат запроса
GET /users
Параметры
Имя | Описание |
limit | Лимит отображения на одной странице, по умолчанию 100 |
offset | Смещение получения выборки |
Результат
В случае успеха сервер возвращает объект со списком дополнительных аккаунтов (list) и их общим количеством отдельной записью (all_count). Каждый элемент массива list представляет собой информацию о дополнительном аккаунте
Имя | Описание |
account_id | Уникальный идентификатор аккаунта |
account_email | Email аккаунта |
account_first_name | Имя |
account_last_name | Фамилия |
account_type | Тип аккаунта (user, client) |
account_lang | Язык аккаунта |
account_sites_count | Количество доступных сайтов для аккаунта |
is_blocked_by_limits | Значение bool. Закончились ли лимиты |
Пример ответа
{
«list»: [
{
«account_id»: 36865,
«account_email»: «[email protected]»,
«account_first_name»: «John»,
«account_last_name»: «Doe»,
«account_type»: «user»,
«account_lang»: «ru»,
«account_sites_count»: 2,
«is_blocked_by_limits»: false
},
{
«account_id»: 36828,
«account_email»: «[email protected]»,
«account_first_name»: «Jane»,
«account_last_name»: «Doe»,
«account_type»: «client»,
«account_lang»: «ru»,
«account_sites_count»: 1,
«is_blocked_by_limits»: false
}
],
«all_count»: «2»
}
Получение расширенной информации о дополнительном аккаунте
Описание
Метод позволяет получить расширенную информацию о дополнительном аккаунте, включая лимиты и разрешения.
Формат запроса
GET /users/{id}
Результат
В случае успеха сервер возвращает объект, состоящий из трех элементов:
Имя | Описание |
settings | Информация о дополнительном аккаунте |
access | Доступы дополнительного аккаунта |
limit | Лимиты дополнительного аккаунта |
Элемент access состоит из следующих возможных полей:
Имя | Описание |
audit_website | Аудит сайта |
competitors_visibility_ranking | Видимость |
audit_settings | Настройки аудита |
backlink_monitor | Мониторинг бэклинков |
analytics_conversions | Аналитика: конверсии |
analytics_google_search_console | Google Search Console |
competitors_added | Основные конкуренты |
analytics_overview | Аналитика: обзор |
analytics_pages | Аналитика: страницы |
marketing_plan | План по продвижению сайта |
seo_potential | SEO-потенциал |
analytics_snippets | Аналитика: сниппеты |
social_media | SMM-модуль |
tools_backlinks_checker | Анализ бэклинков |
tools_index_status_checker | Проверка индексации |
tools_parameter_checker | Проверка параметров |
tools_keyword_grouper | Кластеризация |
tools_engine_autocomplete | Сбор поисковых подсказок |
tools_search_volume_checker | Проверка частотности |
tools_competitive_research | Анализ конкурентов |
tools_keyword_research | Анализ ключевых слов |
tools_one_page_seo_checker | SEO-анализ страницы |
competitors_serp | Мониторинг топ-100 |
analytics_traffic_sources | Аналитика: источники трафика |
analytics_audience | Аналитика: аудитория |
audit_page_changes_monitor | Аудит: отслеживание изменений |
hide_search_volume | Скрытая частотность для аккаунтов клиентов |
show_groups | Показать группы |
report_manual | Ручной отчет |
report_sheduled | Автоматический отчет |
report_template | Шаблон отчета |
Элемент limit состоит из следующих возможных полей:
Имя | Описание |
site | int, лимиты на добавления сайтов |
keyword | int, лимиты на добавления ключевых слов |
backlink | int, лимиты на добавления проверок бэклинков |
audit_account | int, лимит на проверки сайта (на аккаунт) |
audit_site | int, лимит на проверки сайта (на один сайт за месяц) |
balance.amount | int, лимиты оплаты |
balance.period | string, лимит оплаты (day, week, month) |
Пример ответа
{
«setting»: {
«account_id»: 36828,
«account_email»: «[email protected]»,
«account_first_name»: «Test»,
«account_last_name»: «Test»,
«account_type»: «user»,
«account_lang»: «ru»
},
«access»: [
«add_website»,
«audit_settings»,
«report_manual»,
«report_sheduled»,
«report_template»
],
«limit»: {
«site»: 10,
«keyword»: 5,
«backlink»: 10,
«audit_account»: 4,
«audit_site»: 3,
«balance»: {
«amount»: 5,
«period»: «day»
}
}
}
Создание дополнительного аккаунта
Описание
Метод позволяет создать дополнительный аккаунт и отправить письмо-уведомление на имейл созданного аккаунта.
Имя | Обязательный | Описание |
key | Да | Обязательное значение “data” |
value | Да | Параметры создаваемого аккаунта |
setting.account_email | Да | Имейл будущего дополнительного аккаунта |
setting.account_first_name | Да | Имя дополнительного аккаунта |
setting.account_last_name | Нет | Фамилия дополнительного аккаунта |
setting.account_password | Да | Пароль дополнительного аккаунта |
setting.account_lang | Нет | Язык аккаунта. Двухбуквенный код |
setting.account_type | Нет | Тип аккаунта: client, user |
limit.balance.period | Нет | Период действия для лимитов day,week,month |
limit.balance.amount | Нет | Значение лимита в деньгах, int |
access | Нет | Доступы создаваемого дополнительного аккаунта к функциям своего личного кабинета |
Формат запроса
POST /users
[
{
«key»:»data»,
«value»: [
{«setting.account_email»:»[email protected]»},
{«setting.account_first_name»:»Test»},
{«setting.account_last_name»:»Test»},
{«setting.account_password»:»TestPassword»},
{«setting.account_type»:»user»},
{«limit.balance.period»:»day»},
{«limit.balance.amount»:10},
{«access»: [
«add_website»,
«audit_settings»,
«report_manual»,
«report_sheduled»,
«report_template»
]
}
]
}
]
Результат
В случае успеха сервер возвращает уникальный идентификатор для добавленного аккаунта.
Пример ответа
{
«id»: 36872
}
Имя | Описание |
id | Уникальный идентификатор аккаунта |
Удаление дополнительного аккаунта
Описание
Метод позволяет удалить дополнительный аккаунт пользователя.
Формат запроса
DELETE /users/{id}
Результат
В случае успеха сервер возвращает код ответа 201
Редактирование дополнительного аккаунта
Описание
Метод позволяет редактировать существующий дополнительный аккаунт.
Имя | Обязательный | Описание |
key | Да | Обязательное значение “data” |
value | Да | Параметры создаваемого аккаунта |
setting.account_email | Нет | Имейл будущего саб аккаунта |
setting.account_first_name | Нет | Имя дополнительного аккаунта |
setting.account_last_name | Нет | Фамилия дополнительного аккаунта |
setting.account_password | Нет | Пароль дополнительного аккаунта |
setting.account_lang | Нет | Язык аккаунта. Двухбуквенный код |
setting.account_type | Нет | Тип аккаунта: client, user |
limit.balance.period | Нет | Период действия для лимитов day,week,month |
limit.balance.amount | Нет | Значение лимита в деньгах, int |
access | Нет | Секция с новыми разрешениями дополнительного аккаунта |
Формат запроса
PATCH(POST) /users/{id}
[
{
«key»:»data»,
«value»: [
{«setting.account_email»:»[email protected]»},
{«setting.account_first_name»:»Test»},
{«setting.account_last_name»:»Test»},
{«setting.account_password»:»TestPassword»},
{«setting.account_type»:»user»},
{«limit.balance.period»:»day»},
{«limit.balance.amount»:10},
{«access»: [
«add_website»
]
}
]
}
]
Результат
При запросе POST В случае успеха сервер возвращает пустой массив.
Пример ответа
{
[]
}
Получение списка сайтов, открытых дополнительному аккаунту родительским аккаунтом
Описание
Метод позволяет получить список сайтов, доступных для дополнительного аккаунта.
Формат запроса
GET /users/{id}/shared-sites
Имя | Описание |
id | Уникальный идентификатор дополнительного аккаунта |
Результат
В случае успеха сервер возвращает массив уникальных ID сайтов, доступных для дополнительного аккаунта.
Пример ответа
[
39,
44
]
Получение списка сайтов, принадлежащих дополнительному аккаунту
Описание
Метод позволяет получить список сайтов, принадлежащих дополнительному аккаунту.
Формат запроса
GET /users/{id}/own-sites
Имя | Описание |
id | Уникальный идентификатор аккаунта |
Результат
В случае успеха сервер возвращает массив уникальных ID сайтов, принадлежащих дополнительному аккаунту.
Пример ответа
[
39,
44
]
Предоставление доступа к сайтам дополнительному аккаунту
Описание
Метод позволяет предоставить доступ к сайту дополнительному аккаунту.
Формат запроса
POST /users/{id}/shared-sites
[39,42]
Имя | Описание |
id | Уникальный идентификатор аккаунта |
39,42 | Уникальные идентификаторы сайтов |
Результат
В случае успеха сервер возвращает пустой массив.
Пример ответа
{
[]
}