JS API предоставляет возможность разрабатывать приложения в Моем Мире и подключать внешние сайты с использованием JavaScript.
Библиотека позволяет осуществлять вызовы API прямо из браузера пользователя, минуя ваш сервер, помогая вам экономить трафик и вычислительные ресурсы. Кроме того, она дает доступ к некоторым возможностям, которые не доступны для вызова с сервера.
Для использования JS API вам нужно:
<script type="text/javascript" src="http://connect.mail.ru/js/loader.js"> </script>
Важно! Для корректной работы JS API на многостраничных приложениях необходимо передавать на внутренние страницы все GET-параметры, которые приложение получает на главной странице. Это не относится к сайтам.
Файл receiver.html нужен для кроссдоменной передачи данных через JavaScript в старых браузерах. Он статический и мы не планируем его менять. Загрузите его на ваш сервер и он подойдет для всех приложений и сайтов, которые работают на одном домене.
Мы проверяем содержимое файла receiver.html на побитовое совпадение с оригиналом, поэтому размещать на сервере нужно исходный файл с нашего сервера, без обработки его текстовыми редакторами (они могут вставлять BOM или делать другие преобразования, которые приведут к ошибке при проверке ресивера).
Если вы разрабатываете приложение или сайт и ваше тестовое окружение не доступно из интернета, то мы не сможем проверить правильность файла receiver.html на ваших внутренних серверах и сообщим вам об этом в интерфейсе управления. Однако, адрес должен сохраниться в настройках и будет использоваться в работе JS API. Просто при выкладывании вашего проекта в публичный доступ проверьте, что receiver.html загружен и указан в настройках правильно.
<script type="text/javascript" src="http://connect.mail.ru/js/loader.js">
</script>
<script type="text/javascript">
mailru.loader.require('api', function() {
mailru.app.init('ваш приватный ключ из настроек приложения');
// все готово, здесь можно работать с функциями API
});
</script>
<script type="text/javascript" src="http://connect.mail.ru/js/loader.js">
</script>
<script type="text/javascript">
mailru.loader.require('api', function() {
mailru.connect.init('app_id из настроек сайта',
'ваш приватный ключ из настроек сайта');
// все готово, здесь можно работать с функциями API
});
</script>
Вы можете использовать все функции JS API внутри Flash части вашего приложения. Для этого мы создали Flash API — ActionScript прослойку для вызова функций JS API. Подробнее о подключении и применении читайте на странице документации по Flash API.
Функции JS API разделены на те, которые можно вызывать с сайтов, из приложений и общие функции (доступный и с сайтов, и из приложений). Функции для приложений сгруппированы в объекте mailru.app, для сайтов — mailru.connect, общие — в mailru.common.
Практически все функции работают асинхронно и возвращают результат не напрямую, а в функцию-коллбэк, которую надо указывать первым параметром. Обратите внимание, что перед использованием функций библиотеки надо провести ее инициализацию как описано выше.
Объект, в котором хранятся данные о сессии. Становится доступным после вызова mailru.app.init или mailru.connect.init
{
app_id: "464119", // id вашего приложения
exp: "1273243245", // срок действия сессии
ext_perm: "notifications", // разрешения, данные пользователем вашему приложению
is_app_user: "1", // установлено ли у пользователя приложение
// 1 - установлено, 0 - не установлено
oid: "1324730981306483817", // id пользователя
session_key: "28ec5ee94bb0fdd90e0a86b19317d860", // идентификатор сессии
sig: "00c2bf2d9ec6334b92f3856351c6dd1a", //
, настоятельно
// рекомендуем ее проверять на сервере при
// использовании данных для авторизации
ss: "d41d8cd98f00b204e9800998ecf8427e", // не используется
state: "", // не используется
vid: "1324730981306483817" // id текущего пользователя, который вы можете
// использовать для авторизации
}
Про различие между vid и oid читайте в руководстве по социальным приложениям. Для внешних сайтов oid всегда равен vid.
Некоторые действия пользователь может сделать самостоятельно с помощью кнопок на канве вашего приложения, а так же с помощью диалогов, которые ваше приложение может поднимать. Например, пользователь может установить ваше приложение сам, а может в вызванном вами диалоге. Для таких случаев предусмотрен механизм событий. Когда пользователь производит действие, не важно из диалога, поднятого ваши с помощью JavaScript библиотеки, или из интерфейса Моего Мира, вызывается ваша функция-обработчик, которая реагирует на это событие как вам нужно.
Для работы с событиями используйте функции events.listenjs и events.removejs. В документации функций, которые могут генерировать события, указано какие именно события генерируются.