mobile.getCanvas rest api

Возвращает информацию о канве приложения в мобильном Моем Мире.

Функция предназначена для использования в мобильных социальных приложениях. Код двух блоков, который возвращает функция — заголовка и подвала — обязателен к размещению на всех страницах мобильного приложения в качестве самого первого и самого последнего визуального элемента.

Результат выполнения функции разрешается кешировать на время, не превышающее 1 минуты. Для каждого пользователя информация должна кешироваться отдельно.

Данный вызов не предназначен для запросов по защищенной схеме «сервер-сервер» (флаг secure не должен быть 1).

Параметры

Имя Тип Описание
mobile_specstringтип мобильного приложения (см. параметр mobile_spec), от этого параметра зависит какие именно заголовок и подвал будут возвращены; обязательный параметр

Результат

Формат ответа для json-выдачи (результат для xml аналогичен):

  1. {
  2.     "header": "...html...", // html заголовка, должен быть вставлен в начало страницы
  3.     "footer": "...html..." // html подвала, должен быть вставлен в конец страницы
  4. }

Коды ошибок

КодОписание
1Unknown error: Please resubmit the request.
2Unknown method called.
3Service Unavailable. Please try again later.
4Method is deprecated.
100One of the parameters specified is missing or invalid.
102User authorization failed: the session key or uid is incorrect.
103Application lookup failed: the application id is not correct.
104Incorrect signature.
105Application is not installed for this user.
200Permission error: the application does not have permission to perform this action.

Пример вызова

http://appsmail.ru/platform/api?sig=16489adb1f1748432e425b1bcdbe174d&
session_key=cf55910387bb86a660fcd2b9999026b2&mobile_spec=smartphone&
app_id=475376&method=mobile.getCanvas

Пример ответа в формате JSON

  1. {
  2.  "header":"\r\n<style>\r\n    .b-head {\r\n        height:  30px;\r\n        background: url('http://img0.imgsmail.ru/r/mymobile/apps/canvas-header-bg.png') repeat-x;\r\n    }\r\n    .b-head a {\r\n        display: block;\r\n        height: 30px;\r\n        background: url('http://img1.imgsmail.ru/r/mymobile/apps/canvas-header.png') no-repeat;\r\n    }\r\n</style>\r\n<div class=\"b-head\">\r\n\t<a href=\"http://m.my.mail.ru/apps\"></a>\r\n</div>",
  3.  "footer":"\r\n\r\n<div class=\"b-footer\">\r\n    <style type=\"text/css\">\r\n        .b-footer {\r\n            border-top: 1px solid #f8f8f8;\r\n        }\r\n        .b-footer, .b-footer a {\r\n            font-family: Arial, sans-serif;\r\n        }\r\n        .b-footer .l-twoButtons {\r\n            list-style: none;\r\n            padding: 0;\r\n            margin: 0;\r\n            height: 30px;\r\n            border-bottom: 1px solid #c8c8c9;\r\n            border-top: 1px solid #c8c8c9;\r\n            box-shadow: 0 1px 2px rgba(50, 50, 50, 0.1);\r\n            position: relative;\r\n            z-index: 1;\r\n        }\r\n        .b-footer .l-twoButtons .l-twoButtons_item {\r\n            float: left;\r\n            width: 50%;>\r\n            display: block;\r\n            height: 30px;\r\n            background: url('http://img0.imgsmail.ru/r/mymobile/apps/canvas-button-bg.png') repeat-x;\r\n            border-bottom: 1px solid #d6d6d6;\r\n        }\r\n        .b-footer .l-twoButtons .l-twoButtons_item .l-twoButtons_link, .b-footer .l-twoButtons .l-twoButtons_item a {\r\n            height: 30px;\r\n            line-height: 29px;\r\n            font-size: 14px;\r\n            display: block;\r\n            border-left: 1px solid #bbbbbb;\r\n            border-top: 1px solid white;\r\n            background: url('http://img0.imgsmail.ru/r/mymobile/apps/canvas-button-bg.png') repeat-x;\r\n            text-align: center;\r\n            color: #242424;\r\n            text-decoration: none;\r\n            font-family: Arial, sans-serif;\r\n        }\r\n        .b-footer .l-twoButtons .l-twoButtons_item .l-twoButtons_link-apps {\r\n            border-left:  0;\r\n        }\r\n\r\n        .b-footer p {\r\n            text-align: center;\r\n            margin-top: 10px;\r\n            font-size:  12px;\r\n        }\r\n\r\n        \r\n        .b-footer .l-twoButtons .l-twoButtons_item {\r\n            width:  100%;\r\n        }\r\n        \r\n    </style>\r\n    <ul class=\"l-twoButtons\">\r\n        <li class=\"l-twoButtons_item\">\r\n            <a class=\"l-link l-twoButtons_link l-twoButtons_link-apps\" href=\"http://m.my.mail.ru/apps\">Все игры</a>\r\n        </li>\r\n        \r\n    </ul>\r\n    <p>&copy;&nbsp;Mail.Ru, 1999&ndash;2013</p>\r\n</div>\r\n"
  4. }

Пример ответа в формате XML

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <response_mobile_getCanvas>
  3.  <footer>&lt;div class="b-footer"&gt; &lt;style type="text/css"&gt; .b-footer { border-top: 1px solid #f8f8f8; } .b-footer, .b-footer a {
  4. font-family: Arial, sans-serif; } .b-footer .l-twoButtons { list-style: none; padding: 0; margin: 0; height: 30px; border-bottom: 1px solid #c8c8c9; border-top: 1px solid #c8c8c9;
  5. box-shadow: 0 1px 2px rgba(50, 50, 50, 0.1); position: relative; z-index: 1; } .b-footer .l-twoButtons .l-twoButtons_item { float: left; width: 50%;&gt; display: block; height: 30px;
  6. background: url(\'http://img0.imgsmail.ru/r/mymobile/apps/canvas-button-bg.png\') repeat-x; border-bottom: 1px solid #d6d6d6; } .b-footer .l-twoButtons .l-twoButtons_item .l-twoButtons_link,
  7. .b-footer .l-twoButtons .l-twoButtons_item a { height: 30px; line-height: 29px; font-size: 14px; display: block; border-left: 1px solid #bbbbbb; border-top: 1px solid white; background:
  8. url(\'http://img0.imgsmail.ru/r/mymobile/apps/canvas-button-bg.png\') repeat-x; text-align: center; color: #242424; text-decoration: none; font-family: Arial, sans-serif; } .b-footer
  9. .l-twoButtons .l-twoButtons_item .l-twoButtons_link-apps { border-left: 0; } .b-footer p { text-align: center; margin-top: 10px; font-size: 12px; } .b-footer .l-twoButtons .l-twoButtons_item
  10. { width: 100%; } &lt;/style&gt; &lt;ul class="l-twoButtons"&gt; &lt;li class="l-twoButtons_item"&gt; &lt;a class="l-link l-twoButtons_link
  11. l-twoButtons_link-apps" href="http://m.my.mail.ru/apps"&gt;Все игры&lt;/a&gt; &lt;/li&gt; &lt;/ul&gt; &lt;p&gt;&amp;copy;&amp;nbsp;Mail.Ru,
  12. 1999&amp;ndash;2013&lt;/p&gt;&lt;/div&gt;</footer>
  13.  <header>&lt;style&gt; .b-head { height: 30px; background: url(\'http://img0.imgsmail.ru/r/mymobile/apps/canvas-header-bg.png\') repeat-x; }
  14. .b-head a { display: block; height: 30px; background: url(\'http://img1.imgsmail.ru/r/mymobile/apps/canvas-header.png\') no-repeat; }&lt;/style&gt;&lt;div class="b-head"&gt;&lt;a
  15. href="http://m.my.mail.ru/apps"&gt;&lt;/a&gt;&lt;/div&gt;</header>
  16. </response_mobile_getCanvas>

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

Функции REST API