JavaScript SDK

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

SDK содержит 4 группы методов:

• FAPI.init - инициализация SDK. Должна вызываться до вызова какого-либо метода (как при первом открытии приложений, так и при внутренних переходах по фрейму).
• FAPI.Client
  • FAPI.Client.call - вызов методов API с автоматическим расчетом подписи
• FAPI.Util
  • FAPI.Util.getRequestParameters - получение параметров при обращении к приложению
• FAPI.UI
  • FAPI.UI.getPageInfo - информация о странице (высота, ширина, позиция прокрутки, позиция iframe приложения)
  • FAPI.UI.changeHistory - смена текущего URL пользователя
  • FAPI.UI.postMediatopic - публикация медиатопика с подтверждением пользователя
  • FAPI.UI.scrollTo - прокрутка страницы к указанной позиции
  • FAPI.UI.scrollToTop - прокручивает страницу к началу
  • FAPI.UI.setWindowSize - изменение размера контейнера приложения
  • FAPI.UI.showInvite - диалог приглашения друзей в приложение
  • FAPI.UI.showNotification - диалог отправки уведомлений (уведомления, в отличие от приглашений, можно отправлять пользователям, которые уже используют приложение)
  • FAPI.UI.showPayment - диалог на покупку игровой валюты или игровых предметов
  • FAPI.UI.showPaymentPromo - окно с информцией о текущей акции платёжной системы
  • FAPI.UI.showPermissions - диалог на запрос прав (например, на изменение статуса пользователя)
  • FAPI.UI.showPortalPayment - диалог на покупку ОКов (внутренней валюты одноклассников)
  • FAPI.invokeUIMethod(“prepareMidroll”) - подготовка видеорекламы для показа пользователю во время игровой сессии
  • FAPI.invokeUIMethod(“showMidroll”) - показ видеорекламы для показа пользователю во время игровой сессии
  • FAPI.invokeUIMethod(“showPaymentSubscription”) - показ диалога оформления подписки на товар / услугу в игре.

Подключение библиотеки:

<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

API_callback

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

function API_callback(method, result, data);

Здесь:

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