How You Can Help Ukrainians Today (SE Ranking Team Included)Learn here

Дополнительные аккаунты

Просмотр дополнительных аккаунтов пользователя

Описание

Метод позволяет получить список всех дополнительных аккаунтов пользователя.

Формат запроса

GET /users

Параметры

ИмяОписание
limitЛимит отображения на одной странице, по умолчанию 100
offsetСмещение получения выборки

Результат

В случае успеха сервер возвращает объект со списком дополнительных аккаунтов (list) и их общим количеством отдельной записью (all_count). Каждый элемент массива list представляет собой информацию о дополнительном аккаунте

ИмяОписание
account_idУникальный идентификатор аккаунта
account_emailEmail аккаунта
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_consoleGoogle Search Console
competitors_addedОсновные конкуренты
analytics_overview Аналитика: обзор
analytics_pagesАналитика: страницы
marketing_planПлан по продвижению сайта
seo_potentialSEO-потенциал
analytics_snippetsАналитика: сниппеты
social_mediaSMM-модуль
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_checkerSEO-анализ страницы
competitors_serpМониторинг топ-100
analytics_traffic_sourcesАналитика: источники трафика
analytics_audienceАналитика: аудитория
audit_page_changes_monitorАудит: отслеживание изменений
hide_search_volumeСкрытая частотность для аккаунтов клиентов
show_groupsПоказать группы
report_manualРучной отчет
report_sheduledАвтоматический отчет
report_templateШаблон отчета

Элемент limit состоит из следующих возможных полей:

ИмяОписание
siteint, лимиты на добавления сайтов
keywordint, лимиты на добавления ключевых слов
backlinkint, лимиты на добавления проверок бэклинков
audit_accountint, лимит на проверки сайта (на аккаунт)
audit_siteint, лимит на проверки сайта (на один сайт за месяц)
balance.amountint, лимиты оплаты
balance.periodstring, лимит оплаты (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Уникальные идентификаторы сайтов

Результат

В случае успеха сервер возвращает пустой массив.

Пример ответа

{
[]
}