Параметра




Скачать 88.63 Kb.
Название Параметра
Тип Документы
rykovodstvo.ru > Руководство ремонт > Документы
Подключение авторизации сайта к каталогу игр Webtomat

Данное руководство предназначено для подключения к каталогу игр Webtomat собственную систему авторизации пользователей через подключаемый сайт, что позволит более тесно интегрировать каталог с сайтом.

Порядок подключения сайта

Для подключения авторизации сайта сначала необходимо сделать запрос в тех.поддержку через тикет-систему. После одобрения, в разделе Редактирование площадки появятся Дополнительные параметры:

  1. URL API сайта (REST API)

  2. URL авторизации

  3. Ваш секретный ключ

Необходимые методы API, а также работа скрипта авторизации описаны в данном руководстве в соответствующих разделах. После создания API, настройки авторизации, можно протестировать работу, разместив любую игру у себя на сайте.

  1. REST API

API сайта включает в себя следующие методы:

  1. getAppFriends - позволяет получить список друзей пользователя.

Название параметра

Обязательный

Описание

uid




Идентификатор пользователя, у которого требуется получить список друзей. По умолчанию принимает значение текущего пользователя

Пример запроса

http://yoursite.com/api.php?method=getAppFriends&api_id=786&user_id=2296285&access_token=2164a69d64bdc700f9525711f6e7b905

Пример результата



< response >

123

124

125



  1. getProfiles - позволяет получить информацию о пользователе на сайте.

Название параметра

Обязательный

Описание

uids

да

Перечисленные через запятую идентификаторы пользователей, не более 100

Пример запроса

http://yoursite.com/api.php?method=getProfiles&api_id=786&user_id=2296285&uids=123,124,125&access_token=2164a69d64bdc700f9525711f6e7b905

Пример результата



< response >



123

Вася

Пупкин


http://yoursite.com/img/1.jpg



http://yoursite.com/img/1.jpg


2

1988-06-22


http://yoursite.com/profile/id123






124

Алёна

Иванова


http://yoursite.com/img/1.jpg



http://yoursite.com/img/1.jpg


1

1988-08-06


http://yoursite.com/profile/id124





125

НЛО

Внеземное


http://yoursite.com/img/1.jpg
>


http://yoursite.com/img/1.jpg


0

1988-08-06


http://yoursite.com/profile/id125


</</i>user
>
</</i>response>

  1. wallPost – отправляет сообщение на стену/ленту активности пользователю.



Название параметра

Обязательный

Описание

uid

да

Идентификатор пользователя, которому отправляется сообщение

message

да

Сообщение, которое получит пользователь, в кодировке utf-8

Пример запроса

http://yoursite.com/api.php?method=wallPost&api_id=786&user_id=2296285&uid=123&message=test_message&access_token=2164a69d64bdc700f9525711f6e7b905

В ответ на полученный запрос сайт должен оставить сообщение на стене пользователя.

Выполнение запросов к API

Для того чтобы вызвать метод API сайта, клиент осуществляет POST запрос на указанный URL API сайта:

http://yoursite.com/api.php?method=METHOD&api_id=API_ID&user_id= UID&PARAMETERS&access_token=ACCESS_TOKEN

,где

METHOD – название метода из списка методов REST API

API_ID – идентификатор приложения, из которого осуществляется запрос

UID – идентификатор пользователя, который осуществляет запрос

PARAMETERS – параметры соответствующего метода

ACCESS_TOKEN – ключ доступа, уникальный для каждого пользователя

Пример запроса

http://yoursite.com/api.php?method=getProfiles&api_id=786&user_id=2296285&uids=123,124,125&access_token=2164a69d64bdc700f9525711f6e7b905

АPI сайта обязан проверять access_token на валидность. Ключ формируется следующим образом:

access_token = md5(api_id+user_id+secret_key)

, где secret_key – секретный ключ Вашей площадки. Его можно получить в редактировании площадки.

Пример

//uid=123456

//api_id=786

//secret_key=a7365a399f9015050c6eda0905b6a7fd

access_token = md5("786123456a7365a399f9015050c6eda0905b6a7fd") = 2680bb809d73f5ee3e8ee9d71b41c1d5

В случае если пользователь не авторизован

  1. АВТОРИЗАЦИЯ

Для интеграции механизма авторизации пользователя в играх необходимо добавить на страницу с игрой следующий код:





tomatAPI.init({

webId : 1, //идентификатор Вашей площадки в системе вебтомат

login : loginFunction, //функция, которая будет вызываться при попытке авторизации

logout : logoutFunction, // функция, которая будет вызываться при деавторизации

uid : 123456, // идентификатор пользователя на сайте

token : "2680bb809d73f5ee3e8ee9d71b41c1d5"

});

</</i>script>

Авторизация пользователя

Нужно добавить, что вызов tomatAPI.init нужно делать при открытии игры каждый раз, а не единожды при загрузке (актуально для динамической загрузки игр)

Возможны следующие ситуации авторизации и деавторизации:

  1. Пользователь авторизован до входа в игру

  2. Пользователь авторизуется во время игры через интерфейс сайта

  3. Пользователь авторизуется во время игры через интерфейс игры

  4. Пользователь не авторизован

  5. Пользователь деавторизуется во время игры через интерфейс сайта

  6. Пользователь деавторизуется во время игры через интерфейс игры

Варианты реализаций каждой из ситуаций:

  1. Пользователь авторизован до входа в игру.

tomatAPI.init({

webId : 1,

login : loginFunction,

logout : logoutFunction,

uid : 123456,

token : "2680bb809d73f5ee3e8ee9d71b41c1d5"

});

,где

login js-функция, которая будет вызываться при авторизации пользователя

logout - js-функция, которая будет вызываться при деавторизации пользователя

uid - идентификатор пользователя на сайте

token – проверочный ключ пользователя

При такой инициализации игровой контейнер получит данные авторизованного пользователя во время входу в игру.

  1. Пользователь авторизуется во время игры через интерфейс сайта. Возможны 2 варианта авторизации:

  • без перезагрузки страницы:

tomatAPI.onLogin({

uid : 123456,

token : "2680bb809d73f5ee3e8ee9d71b41c1d5"

});

  • с перезагрузкой страницы – при такой авторизации повторяется ситуация «Пользователь авторизован до входа в игру»

3. Пользователь авторизуется во время игры через интерфейс игры. В таком случае вызывается js-функция, переданная при инициализации tomatAPI в параметре login. Эта функция, например, может поднимать диалоговое окно авторизации Вашего сайта, или перенаправлять пользователя на страницу авторизации (крайне не рекомендуется, так как закрытие игрового окна может отрицательно повлиять на лояльность пользователей, в таком случае рекомендуется открывать окно авторизации в отдельной вкладке, после авторизации вызывать tomatAPI.onLogin )

4. Пользователь не авторизован

tomatAPI.init({

webId : 1,

login : loginFunction,

logout : logoutFunction,

});

4. Пользователь деавторизуется во время игры через интерфейс сайта.

Деавторизовать пользователя в игре без перезагрузки страницы можно так:

tomatAPI.onLogout();

При перезагрузке страницы повторится ситуация «Пользователь не авторизован»

4. Пользователь деавторизуется во время игры через интерфейс игры.

В таком случае вызывается js-функция, переданная при инициализации tomatAPI в параметре logout . Эта функция, например, может поднимать диалоговое окно подтверждения деавторизации, или обновить страницу с уже удалённой пользовательской сессией.

URL Авторизации

В момент авторизации пользователя на Вашем сайте, клиент получает uid и token, эти данные передаются на URL авторизации на серверной стороне. В ответ должны вернуться пользовательские данные в формате JSON.

Пример запроса

http://yoursite.com/auth.php?uid=123456&appid=123& token=2164a69d64bdc700f9525711f6e7b905

Пример результата

{"first_name":"Vasya","last_name":"Pupkin","uid":"123456","photo":"http:\/\/yoursite.com\/img\/photo.jpg",,"photo_big":"http:\/\/yoursite.com\/img\/photo.jpg","sex":2,"bdate":"1988-06-22","profile":"http:\/\/yoursite.com\/profile\/id123456"}

  1. ПОЛЬЗОВАТЕЛЬСКИЕ ДАННЫЕ

Для правильного отображения пользовательских данных в игре, а также для лучшего рекламного таргетинга необходимо предоставлять следующий набор данных пользователя:

Название параметра

Обязательный

Описание

uid

да

Уникальный идентификатор пользователя

first_name

да

Имя пользователя

last_name

да

Фамилия пользователя

photo

да

Аватар пользователя (50x50)

photo_big




Фото пользователя (200x200)

sex




Пол.

Муж – 2

Жен – 1

Не определён – 0

bdate




Дата рождения в формате "YYYY-MM-DD"

profile

да

Ссылка на профиль пользователя на сайте

Указаны рекомендуемые размеры фото пользователя. В ином случае фото будет масштабироваться.

  1. КРОССДОМЕННАЯ ПОЛИТИКА БЕЗОПАСНОСТИ

Для того чтобы flash-клиент мог осуществлять запросы к API сайта, необходимо наличие файла crossdomain.xml в корне сайта. Содержимое файла:










Похожие:

Параметра icon Техническое задание № п/п Наименование параметра Требуемая функция...
Обучение не менее 2 (двух) специалистов Заказчика специалистом, сертифицированным фирмой-производителем
Параметра icon Лабораторная работа №3 Указания к выполнению
При установке значения параметра необходимо указывать реально существующий каталог
Параметра icon Техническое задание требование шлифовальный блок inLab mc XL (Sirona) №
Характеристики предлагаемого оборудования / наличие функции или величина параметра, заданная по тз
Параметра icon П/п Технические характеристики (наименование параметра)
...
Параметра icon Статьи на русском
Проводится сравнительный анализ структурной скрытности хаотической последовательности при совместной оценке неизвестного начального...
Параметра icon Описание требований Заказчика Фактическая функция или величина параметра продукции. 1
Кровать лечебно-ожоговая и противопролежневая км-05-02 «Сатурн-90» с подъемным механизмом и регистратором массы пациента
Параметра icon Закончить постройку выбранного объекта
Следующие коды могут также использоваться с параметрами + или соответственно для увеличения или уменьшения параметра
Параметра icon Закончить постройку выбранного объекта
Следующие коды могут также использоваться с параметрами + или соответственно для увеличения или уменьшения параметра
Параметра icon Руководство по эксплуатации Версия 0
Дополнительные установки сделаны для каждой функции параметра. Можно делать полную установку для всей системы контроля
Параметра icon Руководство по эксплуатации мюжк. 406433. 007 Рэ
Преобразователи предназначены для работы в системах автоматического контроля, регулирования и управления технологическими процессами...
Параметра icon Требования производителей автомобилей (oem)
Разберем пример маркировки моторного масла. Для европейского рынка в ней должны присутствовать четыре параметра: вязкость, эксплуатационные...
Параметра icon Описание требований Наличие функции или величина параметра по тз примечание
Демонтаж старой дезинфекционной камеры, установка, монтаж и пусконаладочные работы новой дезинфекционной камеры, бесплатное обучение...
Параметра icon Лабораторная работа Тема. Изучение конструкции и поверка измерительного преобразователя
Сапфир 22мр предназначены для непрерывного преобразования значения измеряемого параметра давления абсолютного (ДА), избыточного (ДИ),...
Параметра icon Руководство по эксплуатации мпп(Н)-6-и-гэ-у2 пс модуль порошкового...
Мпп), предназначен для автоматического подавления очагов пожара классов а (твердых веществ), в (жидких веществ), с (газообразных...
Параметра icon Изменено рекомендуемое значение параметра Lb. 05 c “1” на “
Корректировка имки. 656353. 001-6272 Э4 (листы 1…4) и имки. 656353. 001-6272 Э3 (листы 2,2а)
Параметра icon Техническое задание основные технические характеристики сверлильно-фрезерного...
Основные технические характеристики сверлильно-фрезерного обрабатывающего центра с чпу тс-510 (2 ед.)

Руководство, инструкция по применению






При копировании материала укажите ссылку © 2024
контакты
rykovodstvo.ru
Поиск