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

Репозиторий на Github: ok-js-sdk

Примеры приложений с SDK: ok-js-sdk/samples

Внешним JavaScript SDK могут воспользоваться разработчики MOBILE_HTML и внешних браузерных приложений.

Оно позволяет:

• авторизоваться через клиентский OAuth для внешних приложений;
• вызывать REST-методы;
• реализовать внутриигровые платежи (по аналогии с js sdk) для MOBILE_HTML приложений;
• реализовать показ внутриигровой видеорекламы;
• делать записи к пользователю с помощью виджета публикации;
• приглашать/слать нотификации в игру с помощью виджета приглашения и рекомендации игр.

Настройка и подключение SDK

Перед подключением SDK необходимо проверить в настройках приложения:

• нужная платформа добавлена в настройках приложения;
• для MOBILE_HTML приложений:
  • указан Callback url для платежей
• для внешних приложений:
  • включена клиентская авторизация
  • в redirect_uri добавлен передаваемый потом в config и/или текущий url
  • приложение обладает нужными для функционирования правами, для нативных приложений рекомендуется иметь и запрашивать LONG_ACCESS_TOKEN

Для подключения SDK:

• скопировать себе файл oksdk.js из репозитория;
• добавить в head подключение скрипта, например:

<script type="text/javascript" src="oksdk.js"></script>

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

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

• OKSDK.init - инициализация OK SDK.

Перед тем как использовать любой другой метод OK SDK необходимо инициализировать его с помощью вышеуказанного метода (1 раз при загрузке страницы игры)

Работа с REST API OK

• OKSDK.REST.call - вызов REST API методов OK API;
• OKSDK.REST.calcSignature - подсчет подписи для вызова REST API метода OK API.

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

• OKSDK.Payment.show - показ игрового платежа в отдельном окне браузера;
• OKSDK.Payment.showInFrame - показ игрового платежа во встроенном в страницу фрейме;
• OKSDK.Payment.closePaymentFrame - закрытие платежного фрейма;
• OKSDK.Payment.query - получение URL для проведения игрового платежа.

Внутриигровая реклама

• OKSDK.Ads.init - инициализация рекламного API;
• OKSDK.Ads.prepareMidroll - запрос видеорекламы у рекламодателя;
• OKSDK.Ads.showMidroll - показ рекламы;
• OKSDK.Ads.destroy - удаление рекламного виджета.

Виджеты

• OKSDK.Widgets.post - публикация топика в ленте пользователя через виджет публикации;
• OKSDK.Widgets.invite - приглашение пользователя-друга в игру через виджет приглашения/рекомендации;
• OKSDK.Widgets.suggest - отправка рекомендации игры пользователю-другу через виджет приглашения/рекомендации;
• OKSDK.Widgets.getBackButtonHtml - получение кода виджета возвращения в ОК со страницы игры.

Вспомогательные методы

• OKSDK.Util.getRequestParameters - получение списка параметров, переданных приложению в URL;
• OKSDK.Util.md5 - подсчет md5 от строки;
• OKSDK.Util.isLaunchedFromOKApp - проверка того, запущена ли игра из Android-приложения Одноклассников.