Mail.RuПочтаМой МирОдноклассникиИгрыЗнакомстваНовостиПоискВсе проекты
API

Регистрация сайта

url: http://top.mail.ru/json/add

ПараметрОбязательноОписание
apikey
да
Ключ к API, требуется для регистрации сайтов.


category
нет
Опционально, требуется в случае участия в рейтинге (rating=1). Для участия в рейтинге выберите наиболее подходящую для Вашего ресурса категорию рейтинга @Mail.ru. Правильный выбор категории обеспечит Вам наибольший приток целевой аудитории со страниц рейтинга @Mail.ru. А также поможет сравнить популярность своего ресурса с популярностью ресурсов конкурентов.


email
да
Адрес электронной почты, по которому Вам будет выслано подтверждение регистрации счётчика, его ID. Если Вы забудете свой пароль, то сервер сможет выслать Вам его по этому адресу. Также в случае значительной реорганизации рейтинга @Mail.ru по этому адресу Вам может быть послано уведомление. Этот адрес не будет показываться на общедоступных страницах рейтинга @Mail.ru.


ignore_url_warn
нет
Игнорирование ограничения на регистрацию нескольких счетчиков на один домен: ignore_url_warn=yes


password
да

Пароль Вам понадобится, если Вы захотите изменить какие-либо параметры счётчика или удалить свой ресурс из рейтинга @Mail.ru. Также Вы можете закрыть свободный доступ к статистике по Вашему ресурсу - эта статистика будет доступна по паролю.

Во избежание различных проблем с кодировками в пароле можно использовать только цифры, латинские буквы и символы _-+/*^%=~#$@:;.,!?{}()[]. Прописные и строчные буквы различаются. Не менее 7 и не более 15 символов.


public
да
Открытость статистики: 0 (нет) или 1 (да). Вы можете запретить просмотр подробной статистики Вашего ресурса другими пользователями (общедоступной будет только информация о количестве визитов и посетителей, показываемая на страницах рейтинга @Mail.ru). Для доступа к подробной статистике Вы должны будете использовать свой пароль, введённый выше.
После регистрации вы сможете настроить разрешение или запрет просмотра каждого вида отчета по отдельности.


rating
да
Участие в рейтинге: 0 (нет) или 1 (да). Участие в рейтинге не влияет на сбор и показ статистики ресурса.

title
да
Название сайта, будет выводиться на страницах Рейтинг@Mail.ru и в заголовке страниц статистики по ресурсу.
В названии должно быть не более 60 символов. Разрешены русские и латинские буквы нижнего и верхнего регистров, цифры, пробел и символы _ + / = & ! @ * : % . , ? ; ~ # " ' ( ) [ ] { } -


url
да
Адрес (URL), по которому расположен Ваш ресурс. Адрес должен начинаться с http://, не превышать 100 символов в длину и не должен содержать символа @ в имени домена.
Мы поддерживаем кириллические домены в адресе, Вам не нужно вводить их в Punycode.


























Список категорий рейтинга

url: http://top.mail.ru/json/categories

Ответ содержит объект categories с массивом категорий, которые в свою очередь, имеют подкатегории.


Аутентификация 

url: http://top.mail.ru/json/login

ПараметрОбязательноОписание
apikey
нет
Ключ к API, требуется только при аутентификации по хешу от пароля.

session
нет
Сессия, к которой привязывается доступ после успешной аутентификации. При отсутствии создается новый.


id
да
id счетчика


password
да
Пароль к счетчику. При аутентификации по хешу от пароля password не требуется, вместо него используется параметр ph.


seed
нет
Временная соль при аутентификации по хешу от пароля.


ph
нет

Хеш от пароля при аутентификации по хешу от пароля.



action
да
 Управление ответом:
  • при action=redirect при корректной аутентификации редиректит на статистику счетчика, полезно для использования вместе с веб формой
  • при action=json все ответы в json

Ответ содержит json объект, в utf-8. Наличии error показывает, что произошла ошибка. В случае успешной регистрации в action=json ответе будет "logged":"yes".

Варианты использования:

  • аутентификация по паролю: обязательны id,password
  • аутентификация по хешу: обязательны apikey,id,action=json при первом запросе для получения session, salt и seed; во втором запросе (для аутентификации) обязательны apikey,session,id,ph,seed

ph вычисляется как (session, salt и seed получается при первом запросе, текстовые, применяются без unhex. session, seed и ph надо передать во втором запросе):

  • hash1=sha1("password")
  • hash2=sha1(salt+hash1)
  • hash3=xor(hash1, sha1(seed+hash2))
  • ph=hex(hash3)


Редактирование информации

url: http://top.mail.ru/json/edit

ПараметрОбязательноОписание
url
нет
Адрес (URL), по которому расположен Ваш ресурс. Адрес должен начинаться с http://, не превышать 100 символов в длину и не должен содержать символа @ в имени домена.
Мы поддерживаем кириллические домены в адресе, Вам не нужно вводить их в Punycode.

title
нет
Название сайта, будет выводиться на страницах Рейтинг@Mail.ru и в заголовке страниц статистики по ресурсу.
В названии должно быть не более 60 символов. Разрешены русские и латинские буквы нижнего и верхнего регистров, цифры, пробел и символы _ + / = & ! @ * : % . , ? ; ~ # " ' ( ) [ ] { } -


rating
нет
Участие в рейтинге: 0 (нет) или 1 (да). Участие в рейтинге не влияет на сбор и показ статистики ресурса.

password или sessionда

Пароль или сессия для авторизации



pass_new
нет

Пароль Вам понадобится, если Вы захотите изменить какие-либо параметры счётчика или удалить свой ресурс из рейтинга @Mail.ru. Также Вы можете закрыть свободный доступ к статистике по Вашему ресурсу - эта статистика будет доступна по паролю.

Во избежание различных проблем с кодировками в пароле можно использовать только цифры, латинские буквы и символы _-+/*^%=~#$@:;.,!?{}()[]. Прописные и строчные буквы различаются. Не менее 7 и не более 15 символов.


id
да
ID счетчика

email
нет
Адрес электронной почты, по которому Вам будет выслано подтверждение регистрации счётчика, его ID. Если Вы забудете свой пароль, то сервер сможет выслать Вам его по этому адресу. Также в случае значительной реорганизации рейтинга @Mail.ru по этому адресу Вам может быть послано уведомление. Этот адрес не будет показываться на общедоступных страницах рейтинга @Mail.ru.


category
нет
Опционально, требуется в случае участия в рейтинге (rating=1). Для участия в рейтинге выберите наиболее подходящую для Вашего ресурса категорию рейтинга @Mail.ru. Правильный выбор категории обеспечит Вам наибольший приток целевой аудитории со страниц рейтинга @Mail.ru. А также поможет сравнить популярность своего ресурса с популярностью ресурсов конкурентов.


Все параметры кроме id и password, опциональные. 


Код счетчика

url: http://top.mail.ru/json/code

ПараметрОбязательноОписание
id
да
ID счетчика
mode

Вид логотипа: nologo (без логотипа, только код), double (код и логотип)
type_8

Номер картинки (http://top.mail.ru/table.html) или "wot"
pagetype

Тип страницы: html/xhtml

В ответе будет 2 объекта, logo и code, с кодом для вставки.


Настройка цели

url: http://top.mail.ru/json/confgoals

Параметр
Обязательно
Описание
id
да
ID счетчика
password или session
да
Пароль или сессия для авторизации
type

goals
action

Тип действия: add/remove
cond
для action=add

Условия достижения добавляемой цели, тип. Строка для условия задается отдельно.

uss - подстрока в URL

rss - подстрока в Referer

jse - событие из JS (используется для указания Названия для события в целях отображения по человечески)

hd - глубина просмотра (минимум 2)

ts - время на сайте

substr_${cond}

или

substr

для action=add
Строка условия цели (substr или substr_uss, substr_rss, ...)
string

для action=remove

Строка цели для удаления.
name 

Название цели, для отображения в отчете по человечески.
acsrf

Обязательно для action=add|remove. Необходимо указать ACSRF токен для подтверждения действий.

Для получения токена необходимо сделать "пустой" запрос.

В ответе выдается текущий список целей в объекте elements, и прочие данные.

API для регистрации сайтов в Рейтинге Mail.ru.
Создание фильтров, целей и другие настройки подсчета статистики.
Минималистичные Python и PHP модули для работы с API.