Общая информация

Javascript SDK - это SDK для встроенных приложений, которые представляют собой iframe, контент которого расположен на сервере разработчика.

В данный момент это SDK поддерживается для:

• всех приложений, запускаемых на нашей веб-плафторме ok.ru;
• всех новых мобильных приложений, запускаемых на любой из наших мобильных платформ (только часть методов).

Подключение SDK

<script type="text/javascript" src="//api.ok.ru/js/fapi5.js" defer="defer"></script>

При использовании связки js + flash в flash-приложении должен быть установлен параметр “wmode=opaque”.

После каждого перехода внутри iframe, необходимо повторно производить инициализацию методом FAPI.init, а также передавать следующие параметры:

• api_server
• apiconnection
• web_server
• application_key
• session_key
• session_secret_key

Использование SDK

С помощью данного SDK вы можете:

• работать с REST API Одноклассников;
• реализовать социальные механики - публикацию топиков, отправку уведомлений и приглашений в игру между пользователями;
• реализовать внутриигровые платежи и подписки;
• использовать возможности рекламной монетизации;
• работать с окном браузера и фреймом, в котором открыта игра.

Инициализация SDK

• FAPI.init - инициализация SDK должна производиться при первом открытии приложения до вызова какого-либо другого метода SDK, а также при внутренних переходах по фрейму игры.

Внутриигровые платежи

• FAPI.UI.showPayment - диалог на покупку игровой валюты или игровых предметов;
• FAPI.invokeUIMethod(“showPaymentSubscription”) - показ диалога оформления подписки на товар / услугу в игре.

Рекламная монетизация

• FAPI.UI.loadAd - подготовка rewarded-рекламы для показа пользователю во время игровой сессии;
• FAPI.UI.showLoadedAd - показ rewarded-рекламы пользователю во время игровой сессии;
• FAPI.UI.showAd - показ interstitial-рекламы пользователю во время игровой сессии.

Социальные механики

Другие игровые механики

Интеграция с другими сервисами ОК

Анонимные игры

• FAPI.invokeUIMethod(“showLogin”) - авторизация пользователя без его подтверждения;
• FAPI.UI.showLoginSuggestion - авторизация пользователя с его подтверждением.

Работа с REST API

• FAPI.UI.showPermissions - диалог на запрос прав у пользователя (например, на изменение статуса пользователя);
• FAPI.Client.call - вызов методов API с автоматическим расчетом подписи.

Служебные методы

• FAPI.Util.getRequestParameters - получение параметров при обращении к приложению;
• FAPI.UI.getPageInfo - информация о странице (высота, ширина, позиция прокрутки, позиция iframe приложения);
• FAPI.UI.changeHistory - смена текущего URL пользователя;
• FAPI.UI.scrollTo - прокрутка страницы к указанной позиции;
• FAPI.UI.scrollToTop - прокрутка страницы к началу;
• FAPI.UI.setWindowSize - изменение размера контейнера приложения;
• FAPI.invokeUIMethod(“requestFullscreen”) - открытие фрейма игры во весь экран;
• FAPI.invokeUIMethod(“showHideLocation”) - показ подсказки для скролла для закрытия навигационного бара;
• FAPI.invokeUIMethod(“requestDesktopIcon”) - показ окна с предложением сохранить ярлык игры на рабочем столе.

Другие методы

• FAPI.UI.showPaymentPromo - окно с информацией о текущей акции платёжной системы (внутренняя акция ОК);
• FAPI.UI.showPortalPayment - диалог на покупку ОКов (внутренней валюты одноклассников).
• FAPI.invokeUIMethod(“updateStickerSets”) - обновление стикер-сетов на стороне мобильного ОК-приложения;

API_callback

Методы из группы FAPI.UI не требуют передачи callback-функции при вызове. После выполнения метода будет вызвана глобальная функция, которую должен реализовать разработчик. Функция должна иметь следующую сигнатуру:

function API_callback(method, result, data);

Здесь:

• method - название вызванного метода;
• result - результат выполнения (“ok” в случае успеха, “cancel” в случае, если пользователь отменил действие);
• data - дополнительная информация, например, для showInvite() – это список id приглашенных друзей, разделенный запятыми, в формате строки.