# Правила размещения рекламы в игровых приложениях и сервисах VK Mini Apps
Реклама, размещаемая в приложении (тексты и изображения), должна соответствовать [Правилам пользования Сайтом ВКонтакте](https://vk.com/terms), **п. 3** [Правил размещения рекламы](https://vk.com/ads?act=office_help&terms) и законодательству РФ, в частности Федеральному закону «О рекламе» от 13.03.2006 No. 38-ФЗ. 

## Рекламные форматы
Допускается использовать следующие виды рекламных форматов:
1. **Рекламный баннер** — таргетированный рекламный блок с объявлением, который может содержать небольшой текст, одно изображение и кнопку перехода.
2. **Медиареклама (интерстициальная, мид-ролл)** — рекламный блок длиною до 30 секунд, который показывается на весь экран в промежуточные моменты использования приложения.

## В приложениях и сервисах запрещается:
**1.1.** Использовать сторонние рекламные системы монетизации (баннерные и тизерные сети, CPA-системы и другие) и сторонние системы показов медиарекламы, за исключением случаев обмена трафиком между приложениями.
**1.2.** Размещать рекламу в любых всплывающих окнах, а также в окне, открывающемся при просмотре приложения со стены пользователя.
**1.3.** Перекрывать рекламным баннером функциональную область приложения (область, которая необходима пользователю для полноценного взаимодействия с функциями приложения).
**1.4.** Перекрывать рекламный баннер другими функциональными элементами приложения.
**1.5.** Видоизменять рекламный баннер таким образом, чтобы он мог ввести пользователя в заблуждение относительно результатов перехода по нему, а также ограничивать возможность его закрытия. 
> Рекламный баннер и все его составляющие всегда должны отображаться полностью и не сливаться по цвету с фоном в любой отдельный момент времени.
**1.6.** Размещать активную область баннера (нажатие на которую приводит к переходу) ближе, чем на 20 пикселей к другим функциональным элементам приложения. В приложениях, требующих активных и частых нажатий пользователя, не допускается размещать рекламные баннеры вокруг функциональной области приложения.
**1.7.** Неожиданно показывать баннеры в тех областях приложения, на которые пользователь до того нажимал, взаимодействуя с основной функциональностью.
**1.8.** Неожиданно прерывать работу приложения показом медиарекламы.
> Показывать рекламный блок в формате медиарекламы допустимо только в двух случаях:
> а) во время явного процесса загрузки (например, для игровых приложений — следующего уровня или локации); 
> б) по нажатию на кнопку за обозначенный явным образом бонус в рамках функциональности приложения.
**1.9.** Показывать медиарекламу при запуске приложения, а также размещать рекламные баннеры на стартовой странице приложения (во время онбординга).
**1.10.** Показывать более одной медиарекламы подряд.
**1.11.** Предоставлять пользователям денежную или иную материальную компенсацию за просмотр рекламы, в том числе в виде игровой валюты или иных ценностей, если имеется возможность их вывода или конвертации в денежные средства.

Правила | Правила размещения рекламы в игровых приложениях и сервисах VK Mini Apps

API ВКонтакте

# Authorization Code Flow для получения ключа доступа сообщества

Используйте Authorization Code Flow для вызова методов API ВКонтакте с серверной части  вашего приложения (например, из PHP). Ключ доступа, полученный таким способом, не привязан к IP-адресу.

## Получение списка администрируемых сообществ

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

Получите ключ доступа пользователя ([для работы с клиента](api/access-token/implicit-flow-user) или [для работы с сервера](api/access-token/authcode-flow-user)) с правами `scope`= `groups` и сделайте запрос к методу [groups.get](groups.get) с параметром `filter`= `admin`, чтобы получить список идентификаторов администрируемых сообществ.

Затем используйте все полученные значения или их часть в качестве параметра `group_ids`.

## Открытие диалога авторизации

Необходимо перенаправить браузер пользователя по адресу
[`https://oauth.vk.com/authorize`](https://oauth.vk.com/authorize), передав следующие параметры:

* `client_id` (**обязательный**) — идентификатор  вашего приложения.  
* `redirect_uri` (**обязательный**) — адрес, на который будет передан `code` (домен указанного адреса должен соответствовать основному домену в настройках приложения и перечисленным значениям в списке доверенных `redirect uri` — адреса сравниваются вплоть до `path`-части).  
* `group_ids` (**обязательный**) — идентификаторы сообществ, для которых необходимо получить ключ доступа. Параметр должен представлять собой строку, содержащую значения без знака «минус», разделенные запятой.  
* `display` — Указывает тип отображения страницы авторизации. Поддерживаются следующие варианты: 
    *  `page` — форма авторизации в отдельном окне;  
    *  `popup` — всплывающее окно;  
    *  `mobile` — авторизация для мобильных устройств (без использования Javascript) 
* `scope` — битовая маска [настроек доступа приложения](reference/access-rights), которые необходимо проверить при авторизации и запросить отсутствующие.  
* `response_type` — тип ответа, который вы хотите получить. Укажите `code`.  
* `v` (**обязательный**) — [версия API](reference/versions), которую вы используете. Актуальная версия: **:version**.  
* `state` — произвольная строка, которая будет возвращена вместе с результатом авторизации.  

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

```
https://oauth.vk.com/authorize?client_id=1&display=page&redirect_uri=http://example.com/callback&group_ids=123456,654321&scope=messages&response_type=code&v=:version
```

Если пользователь не вошел на сайт, то в диалоговом окне ему будет предложено ввести свой логин и пароль. 

## Разрешение прав доступа

После успешного входа на сайт пользователю будет предложено авторизовать приложение, разрешив доступ к необходимым настройкам, запрошенным при помощи параметра `scope`. Полный список настроек доступен в разделе [прав доступа приложений](reference/access-rights).  

Сейчас для ключей доступа сообщества приложение любого типа может запрашивать права `manage`,`messages`,`photos`,`docs`. Методы, доступные с ключом доступа сообщества, помечены в общем [списке](reference) специальным значком.

## Получение code

После успешной авторизации приложения браузер пользователя будет перенаправлен по адресу `redirect_uri`, указанному при открытии диалога авторизации. При этом код для получения ключа доступа `code` будет передан в `GET`-параметре на указанный адрес: 

```
REDIRECT_URI?code=7a6fa4dff77a228eeda56603b8f53806c883f011c40b72630bb50df056f6479e52a
```

Параметр `code` может быть использован в течение 1 часа для получения ключа доступа к API `access_token` с  вашего сервера.

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

```
REDIRECT_URI?error=invalid_request&error_description=Invalid+display+parameter
```

## Получение access_token

Для получения `access_token` необходимо выполнить запрос с  вашего сервера на [https://oauth.vk.com/access_token](https://oauth.vk.com/access_token), передав следующие параметры:

* `client_id` (**обязательный**) — Идентификатор  вашего приложения  
* `client_secret` (**обязательный**) — Защищенный ключ  вашего приложения (указан в настройках приложения)  
* `redirect_uri` (**обязательный**) — URL, который использовался при получении `code` на первом этапе авторизации. Должен быть аналогичен переданному при авторизации.  
* `code` (**обязательный**) — Временный код, полученный после прохождения авторизации. 

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

```
https://oauth.vk.com/access_token?client_id=1&client_secret=H2Pk8htyFD8024mZaPHm&redirect_uri=http://mysite.ru&code=7a6fa4dff77a228eeda56603b8f53806c883f011c40b72630bb50df056f6479e52a
```

В результате выполнения данного запроса ваш сервер получит следующий JSON:

```JSON
{
   "access_token_123456": "533bacf01e11f55b536a565b57531ac114461ae8736d6506a3",

   "access_token_654321": "a740d2bfe91caaa6eab794e1168da38cdaedc93c92f233638f",

   "groups": [
    {
      "group_id": 123456,
      "access_token": "533bacf01e11f55b536a565b57531ac114461ae8736d6506a3"
    },
    { 
      "group_id": 654321,
      "access_token": "a740d2bfe91caaa6eab794e1168da38cdaedc93c92f233638f"
    }
]

   "expires_in": 0

}
```

В поле `groups` возвращается массив объектов с полями `group_id` (`integer`)  — идентификатор сообщества   и `access_token` (`string`) — ключ доступа сообщества.

Старые поля `access_token` использовать не рекомендуется, они будут упразднены в будущих версиях API.

В случае ошибки будут переданы параметры `error` и `error_description`. 

```JSON
{
  "error": "invalid_grant",
  "error_description": "Code is expired."
}

```

Использование API | Ключ доступа | Authorization Code Flow для получения ключа доступа сообщества

# Authorization Code Flow для получения ключа доступа пользователя

Используйте Authorization Code Flow для вызова методов API ВКонтакте с серверной части вашего приложения (например, из PHP). Ключ доступа, полученный таким способом, не привязан к IP-адресу, но набор прав, которые может получить приложение, ограничен из соображений безопасности.

## Открытие диалога авторизации

Необходимо перенаправить браузер пользователя по адресу
[`https://oauth.vk.com/authorize`](https://oauth.vk.com/authorize), передав следующие параметры:

* `client_id` (**обязательный**) — идентификатор вашего приложения.  
* `redirect_uri` (**обязательный**) — адрес, на который будет передан `code` (домен указанного адреса должен соответствовать основному домену в настройках приложения и перечисленным значениям в списке доверенных `redirect uri`, адреса сравниваются вплоть до `path`-части).  
* `display` — указывает тип отображения страницы авторизации. Поддерживаются следующие варианты: 
    *  `page` — форма авторизации в отдельном окне;  
    *  `popup` — всплывающее окно;  
    *  `mobile` — авторизация для мобильных устройств (без использования Javascript)  Если пользователь авторизуется с мобильного устройства, будет использован тип `mobile`. 
* `scope` –  битовая маска [настроек доступа приложения](reference/access-rights), которые необходимо проверить при авторизации пользователя и запросить отсутствующие.  
* `response_type` — тип ответа, который вы хотите получить (укажите `code`).  
* `state` — произвольная строка, которая будет возвращена вместе с результатом авторизации.  

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

```
https://oauth.vk.com/authorize?client_id=1&display=page&redirect_uri=http://example.com/callback&scope=friends&response_type=code&v=:version
```

Если пользователь не вошел на сайт, то в диалоговом окне ему будет предложено ввести свой логин и пароль. 

## Разрешение прав доступа

После успешного входа на сайт пользователю будет предложено авторизовать приложение, разрешив доступ к необходимым настройкам, запрошенным при помощи параметра `scope`. Полный список настроек доступен в разделе [прав доступа приложений](reference/access-rights).  

Обратите внимание, что некоторые [права доступа](reference/access-rights)  пользователя из списка (например, `messages`) могут быть запрошены только Standalone-приложением — что означает необходимость использования [Implicit Flow](api/access-token/implicit-flow-user) для запроса таких прав. 

## Получение code

После успешной авторизации приложения браузер пользователя будет перенаправлен по адресу `redirect_uri`, указанному при открытии диалога авторизации. При этом код для получения ключа доступа `code` будет передан как `GET`-параметр: 

```
REDIRECT_URI?code=7a6fa4dff77a228eeda56603b8f53806c883f011c40b72630bb50df056f6479e52a 
```

Параметр `code` может быть использован в течение 1 часа для получения ключа доступа к API `access_token` с вашего сервера. 

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

```
REDIRECT_URI?error=invalid_request&error_description=Invalid+display+parameter 
```

## Получение access_token

Для получения `access_token` необходимо выполнить запрос с вашего сервера на [https://oauth.vk.com/access_token](https://oauth.vk.com/access_token), передав следующие параметры:

* `client_id` (**обязательный**) — идентификатор вашего приложения. 
* `client_secret` (**обязательный**) — защищенный ключ вашего приложения (указан в настройках приложения).  
* `redirect_uri` (**обязательный**) — URL, который использовался при получении `code` на первом этапе авторизации. Должен быть аналогичен переданному при авторизации.  
* `code` (**обязательный**) — временный код, полученный после прохождения авторизации. 

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

```
https://oauth.vk.com/access_token?client_id=1&client_secret=H2Pk8htyFD8024mZaPHm&redirect_uri=http://mysite.ru&code=7a6fa4dff77a228eeda56603b8f53806c883f011c40b72630bb50df056f6479e52a
```

В результате выполнения данного запроса ваш сервер получит вновь созданный `access_token`. Вместе с `access_token` серверу возвращается время жизни ключа `expires_in` в секундах. `expires_in` содержит `0`, если токен бессрочный (при использовании `scope` = `offline`). Процедуру авторизации приложения необходимо повторять в случае истечения срока действия `access_token`, смены пользователем своего логина или пароля или удаления приложения из настроек. 

```JSON
{
  "access_token": "533bacf01e11f55b536a565b57531ac114461ae8736d6506a3",
  "expires_in": 43200,
  "user_id": 66748
}
```

Если у пользователя указан email, а приложением были запрошены соответствующие [права](reference/access-rights), сервер также вернет `email` пользователя. 

В случае ошибки будут переданы параметры `error` и `error_description`.

```JSON
{
  "error": "invalid_grant",
  "error_description": "Code is expired."
}
```

Использование API | Ключ доступа | Authorization Code Flow для получения ключа доступа пользователя

# Общие сведения

Для работы со всеми методами API вам необходимо передавать в запросе `access_token` — специальный ключ доступа. Он представляет собой строку из латинских букв и цифр и может соответствовать отдельному пользователю, сообществу или самому вашему приложению.  

В API ВКонтакте для получения ключа доступа используется открытый [протокол OAuth 2.0](https://oauth.net/2/). При этом пользователь не передает логин и пароль приложению, поэтому его аккаунт не может быть скомпрометирован. 

Мы поддерживаем три способа получения ключа доступа по OAuth 2.0:

1. Implicit flow — самый короткий и простой вариант. Ключ возвращается на устройство пользователя, где был открыт диалог авторизации (в виде дополнительного параметра URL). Такой ключ может быть использован только для запросов непосредственно с устройства пользователя (например, для выполнения вызовов из Javascript на веб-сайте или из мобильного приложения). 

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

3. Client credentials flow — авторизация по секретному ключу приложения. Этот подход необходимо использовать только для доступа к специальным [secure](method/secure)-методам. 

## Ключ доступа пользователя

Такой ключ требуется для работы со всеми [методами](method) нашего API, за исключением методов секции [`secure`](method/secure). 

**Ключ доступа** — своего рода «подпись» пользователя в вашем приложении. Он сообщает серверу, от имени какого пользователя осуществляются запросы, и какие [права доступа](reference/access-rights) он выдал вашему приложению. 

Получить ключ доступа пользователя можно одним из этих способов:

*  [Implicit flow](api/access-token/implicit-flow-user). Для работы с API от имени пользователя в Javascript-приложениях и Standalone-клиентах (десктопных или мобильных). 
*  [Authorization code flow](api/access-token/authcode-flow-user). Для работы с API от имени пользователя с серверной стороны вашего сайта. 

В iFrame и Flash-приложениях ключ доступа передается при запуске с [остальными параметрами](api/app-run-parameters), вам не нужно самостоятельно реализовывать работу с OAuth. 

## Ключ доступа сообщества

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

С ключом доступа сообщества можно вызывать те методы, которые имеют специальную пометку в общем [списке](reference). 

Получить ключ доступа сообщества можно одним из этих способов:

*  [Implicit flow](api/access-token/implicit-flow-community). Для работы с API от имени сообщества в Javascript-приложениях и Standalone-клиентах (десктопных или мобильных). 
*  [Authorization code flow](api/access-token/authcode-flow-community). Для работы с API от имени сообщества с серверной стороны вашего сайта. 
*  В интерфейсе настроек сообщества. Для этого достаточно открыть раздел **Управление сообществом** (**Управление страницей**, если у вас публичная страница), выбрать вкладку **Работа с API** и нажать **Создать ключ доступа**. 

## Сервисный ключ доступа

Сервисный ключ нужен для запросов, которые не требуют авторизации пользователя или сообщества. Это такие методы, как [`secure.sendNotification`](method/secure.sendNotification) для отправки уведомлений от приложения, или [`secure.addAppEvent`](method/secure.addAppEvent) для добавления информации о достижениях, а также открытые методы, например, [`users.get`](method/users.get). 

Получить сервисный ключ доступа можно в настройках вашего приложения. Ключ не привязан к IP-адресу при использовании с открытыми методами, срок его действия не ограничен. Если ключ был скомпрометирован, вы можете сгенерировать новый ключ, при этом старый будет аннулирован.

Сервисный ключ доступа идентифицирует ваше приложение. Все запросы к API, совершённые с использованием вашего ключа доступа, будут считаться совершёнными от имени вашего приложения. Сервисный ключ доступа можно использовать только для запросов с серверной стороны приложения, его нельзя передавать и хранить на клиенте. 

Для запросов к методам [`secure`](method/secure) сервисный ключ привязан к IP-адресу, с которого был сгенерирован.

Документация о старой схеме получения сервисного ключа доступа доступна на этой странице: [Client credentials flow](api/service-token/client-cred-flow).

## Дополнительно

*  Если вы разрабатываете приложение для iOS, Android или Windows Phone, мы рекомендуем использовать наши [мобильные SDK](sdk/overview) с возможностью авторизации через официальное приложение, установленное на устройстве клиента. 
*  Для встраиваемых iFrame приложений вам не нужно самостоятельно внедрять OAuth для работы с клиента, ключ доступа передается в приложение при запуске (подробнее см. на [этой странице](api/app-run-parameters)). 
*  Для внешних сайтов доступен [виджет авторизации](widgets/auth) — готовое решение для Implicit Flow на веб-сервисе.

Использование API | Ключ доступа | Общие сведения

# Implicit Flow для получения ключа доступа сообщества

Используйте Implicit Flow для вызова методов API ВКонтакте непосредственно с устройства пользователя (например, из Javascript).

## Получение списка администрируемых сообществ

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

Получите ключ доступа пользователя ([для работы с клиента](api/access-token/implicit-flow-user) или [для работы с сервера](api/access-token/authcode-flow-user)) с правами `scope`=`groups` и сделайте запрос к методу [groups.get](groups.get) с параметром `filter`=`admin`, чтобы получить список идентификаторов администрируемых сообществ.

Затем используйте все полученные значения или их часть в качестве параметра `group_ids`.

## Открытие диалога авторизации

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

Необходимо перенаправить браузер пользователя по адресу
[`https://oauth.vk.com/authorize`](https://oauth.vk.com/authorize), передав следующие параметры:

* `client_id` (**обязательный**) — идентификатор вашего приложения. 
* `redirect_uri` (**обязательный**) — адрес, на который будет переадресован пользователь после прохождения авторизации.
* `group_ids` (**обязательный**) —  идентификаторы сообществ, для которых необходимо получить ключ доступа. Параметр должен представлять собой строку, содержащую значения без знака «минус», разделенные запятой.
* `display` — указывает тип отображения страницы авторизации. Поддерживаются следующие варианты: 
    * `page` — форма авторизации в отдельном окне; 
    * `popup` — всплывающее окно; 
    * `mobile` — авторизация для мобильных устройств (без использования Javascript) 

Если пользователь авторизуется с мобильного устройства, будет использован тип `mobile`.
* `scope` — битовая маска [настроек доступа приложения](reference/access-rights), которые необходимо проверить при авторизации и запросить отсутствующие. Сейчас доступны: `manage`,`messages`,`photos`,`docs`.
* `response_type` — тип ответа, который необходимо получить. Укажите `token`.
* `v` (обязательный) — [версия API](reference/versions), которую вы используете. Актуальная версия: `:version`.
* `state` — произвольная строка, которая будет возвращена вместе с результатом авторизации.  


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

```
https://oauth.vk.com/authorize?client_id=1&group_ids=1,123456&display=page&redirect_uri=http://example.com/callback&scope=messages&response_type=token&v=:version
```

## Разрешение прав доступа

После успешного входа на сайт пользователю будет предложено авторизовать приложение, разрешив доступ к необходимым настройкам, запрошенным при помощи параметра `scope`. Полный список настроек доступен в разделе [прав доступа приложений](reference/access-rights).  

Сейчас для ключей сообщества приложение любого типа может запрашивать права `manage`,`messages`,`photos`,`docs`. Методы, доступные с ключом доступа сообщества, помечены в общем [списке](method) специальным значком.

## Получение access_token

После успешной авторизации приложения браузер пользователя будет перенаправлен по адресу `redirect_uri`, указанному при открытии диалога авторизации. При этом ключ доступа к API `access_token` и другие параметры будут переданы в URL-фрагменте ссылки:

```
http://REDIRECT_URI#access_token_XXXXXX= 533bacf01e11f55b536a565b57531ad114461ae8736d6506a3&expires_in=86400
```

Здесь `XXXXXX` — идентификатор сообщества, для которого был запрошен ключ доступа.

В случае возникновения ошибки авторизации в качестве `GET`-параметров в `redirect_uri` будет передана информация об этой ошибке. 

```
http://REDIRECT_URI#error=access_denied&error_description=The+user+or+authorization+server+denied+the+request.
```

Использование API | Ключ доступа | Implicit Flow для получения ключа доступа сообщества

# Implicit Flow для получения ключа доступа пользователя

> Для приложений на iOS, Android, Windows Phone мы рекомендуем использовать [упрощенную схему авторизации через SDK](sdk/overview). 

Используйте Implicit Flow для вызова методов API ВКонтакте непосредственно с устройства пользователя (например, из Javascript). Ключ доступа, полученный таким способом, не может быть использован для запросов с сервера.

## Открытие диалога авторизации

Необходимо перенаправить браузер пользователя по адресу
[`https://oauth.vk.com/authorize`](https://oauth.vk.com/authorize), передав следующие параметры:

* `client_id` (**обязательный**) — идентификатор вашего приложения.
* `redirect_uri` (**обязательный**) — адрес, на который будет переадресован пользователь после прохождения авторизации (см. [`redirect_uri`](#Redirect_uri)).
* `display` — указывает тип отображения страницы авторизации. Поддерживаются следующие варианты:

    * `page` — форма авторизации в отдельном окне;
    * `popup` — всплывающее окно;
    * `mobile` — авторизация для мобильных устройств (без использования Javascript)

    Если пользователь авторизуется с мобильного устройства, будет использован тип `mobile`.
* `scope` — битовая маска [настроек доступа приложения](reference/access-rights), которые необходимо проверить при авторизации пользователя и запросить отсутствующие.
* `response_type` — тип ответа, который необходимо получить. Укажите `token`.
* `state` — произвольная строка, которая будет возвращена вместе с результатом авторизации.
* `revoke=1` — параметр, указывающий, что необходимо не пропускать этап подтверждения прав, даже если пользователь уже авторизован.

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

```
https://oauth.vk.com/authorize?client_id=1&display=page&redirect_uri=http://example.com/callback&scope=friends&response_type=token&v=:version&state=123456
```

### Redirect_uri

**Redirect_uri** — это URL, на который будет переадресован браузер пользователя после разрешения им прав доступа. 

Если вы разрабатываете веб-приложение и хотите работать с API из Javascript, в `redirect_uri` необходимо указать адрес страницы на Вашем сайте. В целях безопасности, этот адрес также должен быть указан в настройках вашего приложения (поля «Адрес сайта», «Базовый домен» и «Доверенный Redirect URI»). 

> **Обратите внимание**, вы не сможете работать с методами, которые помечены как доступные только для Standalone-приложений. Во всех остальных случаях (мобильное, десктопное приложение) необходимо использовать `redirect_uri` по умолчанию: [`https://oauth.vk.com/blank.html`](https://oauth.vk.com/blank.html)

Если пользователь не авторизован ВКонтакте в используемом браузере, то в диалоговом окне ему будет предложено ввести свой логин и пароль.

## Разрешение прав доступа

После успешного входа на сайт пользователю будет предложено авторизовать приложение, разрешив доступ к необходимым настройкам, запрошенным при помощи параметра `scope`. Полный список настроек доступен в разделе [прав доступа приложений](reference/access-rights).  

С ключом пользователя, полученным в Implicit Flow, можно работать с наибольшим количеством прав доступа и соответствующих методов по сравнению с остальными способами авторизации. 

>  **Обратите внимание,** что некоторые права могут быть запрошены только Standalone-приложением (например, право доступа `messages`). Это автоматически означает необходимость использования `redirect_uri` по умолчанию (см. [`redirect_uri`](#Redirect_uri)).


## Получение access_token

После успешной авторизации приложения браузер пользователя будет перенаправлен по адресу `redirect_uri`, указанному при открытии диалога авторизации. При этом ключ доступа к API `access_token` и другие параметры будут переданы в URL-фрагменте ссылки:

```
http://REDIRECT_URI#access_token=533bacf01e11f55b536a565b57531ad114461ae8736d6506a3&expires_in=86400&user_id=8492&state=123456
```

Вместе с ключом `access_token` также будет указано время его жизни `expires_in`, заданное в секундах. `expires_in` содержит `0`, если токен бессрочный (при использовании `scope` = `offline`). Если срок использования ключа истек, то необходимо повторно провести все описанные выше шаги, но в этом случае пользователю уже не придется дважды разрешать доступ. Запрашивать `access_token` также необходимо при смене пользователем логина или пароля или удалением приложения в настройках доступа. 

Кроме того, среди возвращаемых параметров будет указан `user_id` — идентификатор авторизовавшегося пользователя. 

В случае возникновения ошибки авторизации в качестве GET-параметров в `redirect_uri` будет передана информация об этой ошибке. 

```
http://REDIRECT_URI#error=access_denied&error_description=The+user+or+authorization+server+denied+the+request.
```

Использование API | Ключ доступа | Implicit Flow для получения ключа доступа пользователя


# Требования к отображению рекламных записей

## Получение рекламных записей

Для приложений с функциональностью ленты новостей метод [`newsfeed.get`](method/newsfeed.get), кроме обычных записей возвращает рекламные записи — промопосты.

В вызове [`newsfeed.get`](method/newsfeed.get) необходимо дополнить параметр `filters` значением `ads_post`, а также передавать дополнительный параметр `device_info`, содержащий следующие поля:
* `app_version` — версия приложения;
* `app_build` — билд приложения;
* `manufacturer` — производитель, кроме iOS;
* `device_model` — модель устройства;
* `system_name` — название системы (iOS, Android);
* `system_version` — версия системы (6.2, 11.0.2);
* `ads_device_id` — ID устройства,
* `ads_android_id` — Android ID, только для Android;
* `ads_tracking_disabled` — `0`, если отслеживание разрешено пользователем, `1` — запрещено.

Для пагинации ленты новостей необходимо использовать параметры `start_from`/`next_from`.

В работе с рекламными записями в ленте используйте отдельные методы для жалоб и скрытия источника из ленты: `adsint.reportAd`, `adsint.hideAd`.

### Метод adsint.reportAd

`Параметры:`
* `ad_data` (`string`, **required**) — значение поля `ad_data` из рекламного объявления.
* `reason` (`string`) — причина жалобы. Возможные значения:
   * `spam` — спам;
   * `insult` — оскорбление;
   * `porn` — материал для взрослых;
   * `fraud` — мошенничество;
   * `other` — другое.

Ответ:
После успешного выполнения возвращает объект с полем `success`, которое содержит значение `1`.

### Метод adsint.hideAd

Параметры:
* `ad_data` (`string`, **required**) — значение поля `ad_data` из рекламного объявления.
* `object`_type` (`string`) — тип скрываемого объекта. Допустимые значения:
   * `ad` — рекламное объявление;
   * `source` — источник рекламного объявления. Только для промопостов.

Ответ
После успешного выполнения возвращает объект с полем `success`, которое содержит значение `1`.

## Формат данных в API

Объект, описывающий рекламную запись, содержит следующие поля:

### `type`
`string`
Тип записи. Всегда содержит значение `ads`.

### `ads_title`
`string`
Заголовок рекламного блока.

### `ads_id1`
`integer`
ID позиции в новостной ленте, часть 1.

### `ads_id2`
`integer`
ID позиции в новостной ленте, часть 2.

### `ads`
`array`
Массив рекламных объявлений, всегда содержит 1 элемент. Объект, описывающий объявление, содержит следующие поля:
* `type` (`string`) — тип объявления, всегда равен `post`;
* `age_restriction` (`string`) — возрастная метка;
* `ad_data` (`string`) — строка для регистрации событий методом `adsint.registerAdEvents` и для действий в методах `adsint.hideAd` и `adsint.reportAd`. Подробнее в разделе [Регистрация событий](#Регистрация%20событий).
* `ad_data_impression` — строка для регистрации событий методом `adsint.registerAdEvents`. Подробнее в разделе [Регистрация событий](#Регистрация%20событий).
* `post` (`object`) — [объект записи на стене](reference/objects/post). В поле `post_type` содержится значение `post_ads`. Дополнительно объект может содержать поле `track_code` (`string`), необходимое для [регистрации событий](#Регистрация%20событий).
* `statistics` (`array`) — массив ссылок на пиксели для [регистрации событий](#Регистрация%20событий).  Каждый объект в массиве содержит поля:
   * `type` (`string`) — тип события. Возможные значения:
      * `load` — данные об объявлении получены через API;
      * `impression` — объявление показано пользователю;
      * `click_post_owner` — переход по заголовку поста (в группу);
      * `click_post_link` — переход по ссылке в посте (включая хэштег, упоминание, внутренние ссылки ВК и внешние);
   * `url` (`string`) — ссылка на пиксель, возможно с промежуточными редиректами.

> Обратите внимание на особенности работы с рекламными записями в некоторых методах:
* В методах секции [likes](method/likes) рекламные записи задаются типом объекта `post_ads`.
* В методе [wall.getById](method/wall.getById) в поле `type` для рекламных записей возвращается значение `post_ads`. Кроме того, в этот метод всегда нужно передавать параметр `track_code` при его наличии.
* В методе [wall.repost](method/wall.repost) для рекламной записи необходимо указывать префикс `wall_ads`.
* В методах секции [messages](messages) в поле `attachment` рекламной записи соответствует тип `wall_ads`. 


## Оформление рекламной записи

Рекламная запись должна быть показана в ленте на той же позиции, на которой она находится в ответе от метода [newsfeed.get](method/newsfeed.get). Для рекламной записи необходимо использовать стандартное оформление блоков в ленте с добавлением заголовка (поле `ads_title`) и возрастного ограничения (`age_restriction`) в верхней части блока. Например:

![](14e49c892345ecb718bfafa56a6c7087b1625cbb6498db71d0e4cb1e "7041681492505805859")

### Регистрация событий

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

### Пиксели статистики

В поле `statistics` объекта, описывающего объявление, возвращаются данные пикселей статистики. Каждый объект, описывающий пиксель, содержит название события в поле `type`  (`string`) (например, переход к владельцу рекламной записи или показ рекламной записи) и URL пикселя, который соответствует этому событию, в поле `url` (`string`).

Как только произошло событие с типом `type`, необходимо открыть URL из соответствующего поля `url`. Каждый тип события может встречаться несколько раз с разными ссылками. При наступлении события нужно загружать все пиксели этого типа, при этом каждая ссылка должна загружаться не более одного раза для событий `load` и `impression`. Для проверки на уникальность события необходимо хранить ключ вида `<type>:<ads_id1>:<ads_id2>` не менее суток (или хранить не менее 1000 последних ключей), и перед отправкой события проверять наличие соответствующего ключа в хранилище.

> Внимание!
URL пикселя может содержать цепочку редиректов. Необходимо корректно обрабатывать файлы cookies в соответствии с заголовками HTTP-ответов.

### adsint.registerAdEvents

В момент показа рекламной записи необходимо вызвать метод `adsint.registerAdEvents` с параметром `events` (`array`) в таком формате:

```JSON
[{
    "event_type": "impression",
    "ad_data_impression": "ZDI0MWVl"
  }, {...}]
```

Каждый элемент массива `events` — объект, который содержит два поля:
* `event_type` (`string`) — всегда должен содержать значение `impression`;
* `ad_data_impression` (`string`) — значение одноименного поля из объекта рекламной записи.

> Внимание!
Метод `adsint.registerAdEvents` нужно вызвать не позднее, чем в течение `5` секунд после того, как произошло событие.

### stats.trackEvents

В момент показа или действия рекламной записью необходимо вызвать метод `stats.trackEvents` с параметром `events` (`array`) в таком формате:

```JSON
[{
    "e":"view_post",
    "post_ids":["123_456", ...],
    "track_code":["sdfsdf", ..]
}, {...}]
```

Каждый элемент массива `events` — объект, описывающий событие. Набор полей в нём зависит от типа события.

## Просмотр рекламной записи

Объект, описывающий событие, содержит поля:

### `e`
`string`
Тип события. Всегда содержит значение _view_post_.

### `post_ids`
(`array`)
Данные о просмотренных записях. Каждый элемент массива представляет собой строку вида `<owner_id>_<post_id>`. Здесь `owner_id` — идентификатор владельца записи, `post_id` — идентификатор записи.

### `track_code`
(`array`)
Значение поля `track_code` из объекта записи. Элементы массива `track_code` должны поиндексно соответствовать элементам массива `post_ids`.

### `repost_ids`
(`array`)
Данные об оригиналах просмотренных записей, если они являются репостами (только предыдущий пост в цепочке, репостом которого является рекламная запись). Формат аналогичен полю `post_ids`, элементы массива `repost_ids` должны поиндексно соответствовать элементам массива `post_ids`.

## Действие с рекламной записью

Объект, описывающий событие, содержит поля:

### `e`
`string`
Тип события. Всегда содержит значение `ost_interaction`.

### `post_id`
`string`
Строковый идентификатор записи (`owner_id+_+post_id`).

### `action`
`string`
Действие. Возможные значения:
* `expand` — раскрытие записи по кнопке «Показать больше»;
* `open` — открытие записи на отдельном экране;
* `link_click` — переход по ссылке из текста записи;
* `attached_link_click` — переход по ссылке, прикреплённой к записи;
* `snippet_action` —  переход по ссылке в сниппете;
* `audio_start` — начал проигрывать музыку в записи;
* `video_start` — начал проигрывать видео в записи 
* `open_photo` — открытие фотографии из записи;
* `open_layer` — открытие статьи из записи;
* `open_wiki` — открытие вики-страницы; 
* `open_group` — переход в группу;
* `open_user` — переход к пользователю.

### `ad_data`
`string`
Значение `ad_data` из объекта рекламной записи.

### `track_code`
(`string`)
Значение поля `track_code` из объекта записи.

### `link`
`string`
URL ссылки. передаётся, если `action` — `link_click`, `attached_link_click` или `snippet_action`. Для хэштегов передается сам хэштег в виде `#hashtag`.
Для ссылок передается значение в оригинальном виде: `example.com`, `https://vk.com/samsung;, ...` Для mention-ссылок передаётся ссылка, преобразованная в `https://vk.com/...`.

> **Внимание!** Метод [stats.trackEvents](method/stats.trackEvents) нужно вызвать не позднее, чем в течение `1` минуты после того, как произошло событие.

Интеграция | Реклама | Требования к отображению рекламных записей

# Рекламный API

## Что это такое?

Автоматизируйте работу с таргетированной рекламой ВКонтакте с помощью методов API — создавайте креативы, запускайте объявления и целые рекламные кампании, редактируйте настройки и получайте статистику. 

Возможности рекламного API:

*  создание и редактирование кампаний и объявлений;
*  автоматизированная выгрузка статистики;
*  управление и обновление аудиторий ретаргетинга;
*  добавление клиентов, наблюдателей и администраторов в рекламный кабинет.


## Работа с API

Перед вызовом методов API необходимо получить ключ доступа пользователя с помощью [Implicit Flow](api/access-token/implicit-flow-user) или [Authorization Code Flow](api/access-token/authcode-flow-user). После этого вы сможете выполнять любые запросы к API по [стандартной схеме взаимодействия](api/api-requests).

> **Важно:** перед началом работы с рекламным API ознакомьтесь с ограничениями и рекомендациями.

Выбирайте нужные методы для работы в зависимости от задач — [здесь](method/ads) мы собрали методы, которые пригодятся для работы с рекламой.   

При работе иногда могут возникать ошибки, но не стоит их бояться. Понять, что пошло не так, поможет [список ошибок](reference/errors).

## Готовые инструменты

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

* [Active Traffic](https://www.activetraffic.ru/)  —  массовое создание и настройка объявлений, аналитика и статистика, автоматические тактики.
*  [Aori](https://aori.ru/) — единая платформа для управления рекламой с простым интерфейсом.
* [Atuko](https://atuko.ru) — массовое создание и редактирование рекламных кампаний с помощью Excel-генератора, подключение сторонней аналитики, массовое копирование и перенос кампаний из одного аккаунта в другой, гибкая настройка и выгрузка отчетов.
*  [eLama](https://elama.ru/tools/)  —  калькулятор выгодной ставки за клик, быстрый конструктор креативов, импорт лидов.
*  [ERESH](https://eresh.zemedia.ru/)  —  устраняет рутину при подготовке и управлении кампаниями: помогает с медиапланом, с расчётом бюджета. Сегментирует объявления, управляет ставками, показывает расширенную статистику.
*  [Kairos](https://kairos.zemedia.ru/)  —  управляет кампаниями. Позволяет сделать максимальный выкуп горячей аудитории, достичь заданного охвата или заданного расхода бюджета к дедлайну. Рентабелен для месячных бюджетов от 300 тыс. рублей.
*  [Marylin](https://mymarilyn.ru/)  —  оптимизация рекламных кампаний, управление ставками под заданные KPI, автоматизация рутинных процессов.
*  [Plarin](https://www.plarin.net/)  —  массовое редактирование объявлений. Библиотека шаблонов креативов, их массовое создание. Оптимизация ставок, автоматическая сегментация, графические отчёты.

API ВКонтакте | Реклама | Рекламный API

# Формат запросов

## Синтаксис запроса

Чтобы обратиться к методу API ВКонтакте, нужно выполнить `POST` или `GET` запрос вида:

```
https://api.vk.com/method/METHOD?PARAMS&access_token=TOKEN&v=V
```

Он состоит из нескольких частей:
* `METHOD` (**обязательно**) — название [метода API](method), к которому вы хотите обратиться. 
    > **Обратите внимание:** имя метода чувствительно к регистру.
* `PARAMS` (**не обязательно**) — входные параметры соответствующего метода API, последовательность пар `name=value`, разделенных амперсандом. Список параметров указан на странице с описанием метода.
* `TOKEN` (**обязательно**) — [ключ доступа](api/access-token/getting-started).
* `V` (**обязательно**) — используемая версия API. Использование этого параметра применяет некоторые изменения в формате ответа различных методов. Сейчас [актуальная версия API](reference/versions) — :version. Этот параметр следует передавать со всеми запросами.

Параметры могут передаваться как методом `GET`, так и `POST`. Если вы будете передавать большие данные (больше 2 килобайт), следует использовать `POST` и формат `FormData`.

Например, вызовем метод [`users.get`](method/users.get) для пользователя с идентификатором `210700286`:

```
https://api.vk.com/method/users.get?user_ids=210700286&fields=bdate&access_token=533bacf01e11f55b536a565b57531ac114461ae8736d6506a3&v=:version
```

В ответ на такой запрос вы получите ответ в формате JSON:

```JSON
{
  "response": [
    {
      "id": 210700286,
      "first_name": "Lindsey",
      "last_name": "Stirling",
      "bdate": "21.9.1986"
    }
  ]
}
```

## Общие параметры

Каждый метод API имеет собственный набор входных параметров. Помимо этого, существуют общие параметры, которые могут быть использованы во всех методах:
* `lang` — определяет язык, на котором будут возвращаться различные данные, например, названия стран и городов. Может содержать строковое обозначение языка или его идентификатор (получить идентификатор языка пользователя вы можете методом [`account.getInfo`](method/account.getInfo)). Кириллические имена будут автоматически транслитерированы в латиницу для всех языков, кроме русского, украинского и белорусского.
* `ru` (`0`) — русский,
* `uk` (`1`) — украинский,
* `be` (`2`) — белорусский,
* `en` (`3`) — английский,
* `es` (`4`) — испанский,
* `fi` (`5`) — финский,
* `de` (`6`) — немецкий,
* `it` (`7`) — итальянский.
* `test_mode=1` — тестовый режим, позволяет выполнять запросы из нативного приложения без его включения на всех пользователей.

## Ограничения и рекомендации

### Частотные ограничения

К методам API ВКонтакте (за исключением методов из секций [`secure`](method/secure) и [`ads`](method/ads)) с ключом доступа пользователя можно обращаться не чаще **3** раз в секунду. Для ключа доступа сообщества ограничение составляет **20** запросов в секунду. Если логика вашего приложения подразумевает вызов нескольких методов подряд, имеет смысл обратить внимание на метод [`execute`](method/execute). Он позволяет совершить до **25** обращений к разным методам в рамках одного запроса.

Для сервисного ключа доступа лимиты такие:

| Кол-во пользователей приложения | Частотный лимит (кол-во запросов в секунду) |
| ----------- | ----------- |
| до 10 000 | 5 |
| до 100 000 | 20 |
| до 500 000 | 40 |
| до 1 млн | 50 |
| больше 1 млн | 60 |

Для методов секции [`ads`](method/ads) действуют собственные [ограничения](method/ads#Ограничения%20на%20вызов%20методов%20рекламного%20API).

Максимальное число обращений к методам секции [`secure`](method/secure) зависит от числа пользователей, установивших приложение. Если приложение установило меньше 10 000 человек, то можно совершать 5 запросов в секунду, до 100 000 — 8 запросов, до 1 000 000 — 20 запросов, больше 1 млн. — 35 запросов в секунду.

Если вы превысите частотное ограничение, сервер вернет ошибку с кодом `6: "Too many requests per second."`.

### Количественные ограничения

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

После превышения количественного лимита доступ к конкретному методу может требовать ввода капчи (см. [`captcha_error`](api/captcha-error)), а также может быть временно ограничен (в таком случае сервер не возвращает ответ на вызов конкретного метода, но без проблем обрабатывает любые другие запросы).

## Примеры

### Кроссдоменный запрос с использованием JSONP

Запросы к API ВКонтакте могут быть выполнены из браузера со страниц сторонних сайтов или [IFrame приложений](sdk/overview).

Чтобы осуществлять кроссдоменные запросы к API, вы можете использовать протокол [JSONP](https://ru.wikipedia.org/wiki/JSONP). Для этого необходимо подключать к документу скрипт с адресом запроса в `src`. Запрос должен содержать дополнительный параметр `callback` c именем функции, которая будет вызвана при получении результата.

Например:

```HTML
<html>
   <title>JSONP</title>
   <head></head>
   <body>
      <script type="text/javascript">
         var script = document.createElement('SCRIPT');
         script.src = "https://api.vk.com/method/users.get?user_ids=210700286&fields=bdate&v=:version&callback=callbackFunc";
         document.getElementsByTagName("head")[0].appendChild(script);
         function callbackFunc(result) {
         alert(result.response[0].first_name)
         }
      </script>
   </body>
</html>
```

В нашем примере после загрузки документа вызывается метод [`users.get`](method/users.get), а после получения ответа от сервера управление передается функции `callbackFunc()`, которая выводит содержимое поля `first_name` из ответа во всплывающем окне.

### Запрос из PHP

```PHP
<?php
$user_id = 210700286;
$request_params = array(
    'user_id' => $user_id,
    'fields' => 'bdate',
    'v' => '5.52',
    'access_token' => '533bacf01e11f55b536a565b57531ac114461ae8736d6506a3'
);
$get_params = http_build_query($request_params);
$result = json_decode(file_get_contents('https://api.vk.com/method/users.get?' . $get_params));
echo ($result->response[0]
    ->bdate);
?>
```

В нашем примере скрипт выводит дату рождения пользователя (`bdate`), полученную обращением к методу [`users.get`](method/users.get).

### Запрос с использованием Open API

[Open API](api/open-api/getting-started) — JS-библиотека для упрощения работы с API ВКонтакте на внешних сайтах.

```HTML
<script type="text/javascript">
   VK.Api.call('users.get', { user_ids: 210700286, fields: 'bdate' }, function(r) {
   if(r.response) {
   alert(r.response[0].bdate);
   }
   });
</script>
```

Использование API | Формат запросов

# Параметры запуска приложения

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

Параметры передаются в строке запроса для iFrame-приложений и с помощью `flashVars` для flash-приложений.

## Список параметров

### `api_url`
`string`

URL сервиса API, по которому необходимо осуществлять запросы.
### `api_id`
`integer`

Идентификатор запущенного приложения.
### `api_settings`

Битовая маска настроек [прав доступа](reference/access-rights) текущего пользователя в приложении.

### `viewer_id`
`integer`

Идентификатор пользователя, который запустил приложение.
### `viewer_type`

Тип пользователя, который просматривает приложение

### `access_token`

Ключ доступа для вызова [методов API](method).

### `user_id`
`integer`

Идентификатор пользователя, со страницы которого было запущено приложение. Если приложение запущено не со страницы пользователя, содержит `0`.

### `platform`
`string`

Идентификатор платформы, на которой запускается приложение. Содержит одно из значений:
  * `html5_ios` – мобильное приложение ВКонтакте для iOS;
  * `html5_android` – мобильное приложение ВКонтакте для Android;
  * `html5_mobile` – мобильная версия сайта ВКонтакте;
  * `web` – десктопная версия сайта ВКонтакте. 

### `is_app_user`
`integer`, [`0`, `1`]

Если пользователь установил приложение, содержит `1`, иначе — `0`.

### `sign`
`string`

[Подпись параметров запуска](#sign) (пришла на замену `auth_key` как усиленная альтернатива).

### `sign_keys`
`string`

Параметры, необходимые для генерации `sign`.

### `timestamp`
`integer`

Время генерации `sign`.

### `auth_key`
`string`

Ключ, необходимый для авторизации пользователя на стороннем сервере.

### `language`
`integer`

Идентификатор языка пользователя, просматривающего приложение.

### `parent_language`
`integer`

Идентификатор языка, которым можно заменить язык пользователя (возвращается для неофициальных языковых версий).

### `is_secure`
`integer`, [`0`, `1`]

Если пользователем используется защищенное соединение – `1`, иначе — `0`.

### `api_result`
`string`

Результат первого запроса к API, который выполняется при загрузке приложения.

### `referrer`
`string`

Обозначение места, откуда пользователь перешёл в приложение.

### `hash`
`string`

Хеш запроса (данные после символа `#` в строке адреса).

### `lc_name`, `ads_app_id`

Служебные параметры.

### `is_play_machine`
`integer`, [`0`, `1`]

Если приложение было запущено через Play Machine.

### `viewer_type`
Если приложение запущено со страницы сообщества (`group_id != 0`), параметр `viewer_type` может принимать следующие значения:

* `4` — если пользователь является создателем или администратором сообщества;
* `3` — если пользователь является редактором сообщества;
* `2` — если пользователь является модератором сообщества;
* `1` — если пользователь является участником сообщества;
* `0` — если пользователь не состоит в сообществе.

Если приложение запущено со страницы пользователя (`user_id != 0`), параметр `viewer_type` может принимать следующие значения:

* `2` — если пользователь является владельцем страницы;
* `1` — если пользователь является другом владельца страницы;
* `0` — если пользователь не состоит в друзьях владельца страницы.

### sign
Чтобы получить подпись параметров запуска (`sign`), отфильтруйте вернувшиеся параметры по параметрам, перечисленных в `sign_keys`, затем объедините пары "ключ=значение" с амперсандом в качестве разделителя. От полученной после объединения строки вычисляется хеш-код алгоритмом `SHA256` в бинарном представлении с методом `HMAС`, подписанный защищенным ключом из настроек вашего приложения, и затем кодируется `base64 encode`.

`sign` позволяет защититься от подмены любого из параметров, переданных в приложение, в то время как `auth_key` защищает от подмены только `api_id` и `viewer_id`.

[Пример проверки подписи на PHP](#PHP)
[Пример проверки подписи на Node.js](#Node.js)

## Про auth_key
`auth_key` нужен для проверки подлинности сессии на сервере: чтобы вы могли быть уверены, что данные запроса не подменялись на стороне клиента.
> Мы не рекомендуем использовать параметр `auth_key`, так как в будущем он будет упразднён. Для проверки подлинности сессии используйте параметр `sign`.

`auth_key` вычисляется на сервере ВКонтакте следующим образом:
```
auth_key = md5(api_id + '_' + viewer_id + '_' + api_secret)
```
Здесь `api_id` — идентификатор вашего приложения, `viewer_id` — идентификатор пользователя, `api_secret` — защищённый ключ (вы можете узнать его в разделе редактировании приложения на вкладке **Редактирование** → **Настройки**, поле **Защищённый ключ**).
Чтобы не производить дополнительную авторизацию пользователя на своём сервере, всегда проверяйте ключ `auth_key` на правильность.

### language
Параметр `language` может принимать следующие значения:

* `0` — русский язык;
* `1` — украинский язык;
* `2` — белорусский язык;
* `3` — английский язык.

## api_result
`api_result` – результат выполнения API-запроса, формирующийся при просмотре приложения. Параметры этого запроса можно ввести в разделе редактирования приложения. Например, для получения информации об указанных пользователях, можно использовать следующий запрос:

```
method=users.get&user_ids={user_id},{viewer_id},1,6492&format=json&v=5.27
```

В данном запросе параметры `{user_id}` и `{viewer_id}` являются переменными. `{user_id}` содержит `id` пользователя, со страницы которого было запущено приложение. `{viewer_id}` – это id пользователя, который просматривает приложение. Также может быть использован параметр `{group_id}`, содержащий id группы, со страницы которой было запущено приложение.

## referrer

Параметр `referrer` может принимать следующие значения:
* `unknown` — источник перехода неизвестен;
* `menu` — переход из левого меню;
* `notification` — уведомление;
* `recommendation` — приложение запущено из блока рекомендаций;
* `friends_feed` — раздел активности друзей в каталоге;
* `catalog_popular` — список популярных приложений в каталоге;
* `catalog_new` — список новых приложений в каталоге;
* `catalog_ads` — рекламный блок в каталоге;
* `quick_search` — результаты быстрого поиска;
* `user_apps` — список собственных приложений пользователя;
* `group` — список приложений в сообществе;
* `featured` — центральный блок баннеров в каталоге;
* `request` — запрос. В этом случае дополнительно вернутся параметры `request_key` и `request_id`;
* `profile_status` — статус профиля;
* `app_suggestions` — специализированный рекламный блок в разделе «Приложения»;
* `join_request` — название приложения в приглашении друга (со страницы https://vk.com/apps);
* `top_grossing` — подборка «Кассовые приложения» в каталоге;
* `friends_apps` — подборка «Приложения друзей» в каталоге;
* `collections` — тематические подборки в каталоге;
* `genre` — подборки по жанрам в каталоге;
* `notifications_page` — список оповещений на странице https://vk.com/apps;
* `myapps_page` — список «Мои приложения» (https://vk.com/apps?act=apps).
* `bestsellers` — подборка «Популярные» в каталоге;
* `ad_{AD_ID}` – если приложение было открыто в результате перехода по рекламному объявлению. `{AD_ID}` содержит идентификатор рекламного объявления;
* `super_app` — приложение запущено из вкладки «Сервисы»;
* `home_screen` — приложение запущено с домашнего экрана телефона;
* `apps_games_invite_notify` — приложение запущено из уведомления.

## Примеры проверки подписи

### PHP
```PHP
<?php
$client_secret = 'xxxxx';

$url = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'on' ? "https" : "http") . "://$_SERVER[HTTP_HOST]$_SERVER[REQUEST_URI]";

$query_params = [];
$parsed = parse_url($url, PHP_URL_QUERY);
parse_str($parsed, $query_params); // Получаем query-параметры из URL
$sign_params = [];
$sign_keys = explode(',', $query_params['sign_keys']);
foreach ($sign_keys as $key)
{
    $sign_params[$key] = $query_params[$key];
}

$sign_params_query = http_build_query($sign_params); // Формируем строку вида "param_name1=value&param_name2=value"
$sign = rtrim(strtr(base64_encode(hash_hmac('sha256', $sign_params_query, $client_secret, true)) , '+/', '-_') , '='); // Получаем хеш-код от строки, используя защищеный ключ приложения. Генерация на основе метода HMAC.
$auth_key = md5($sign_params['api_id'] . '_' . $sign_params['viewer_id'] . '_' . $client_secret);

$sign_status = $sign === $query_params['sign']; // Сравниваем полученную подпись со значением параметра 'sign'
echo 'status: ' . ($sign_status ? 'ok' : 'fail') . "\n";
echo date('Y-m-d H:i:s', $query_params['timestamp']) . PHP_EOL;
```
### Node.js
```javascript
const qs = require('querystring');
const crypto = require('crypto');

const urlParams = qs.parse(URL_PARAMS);
const signKeys = new URLSearchParams(URL_PARAMS)
    .get('sign_keys')
    .split(',');

const ordered = {};

signKeys.forEach(key => ordered[key] = urlParams[key]);

const stringParams = qs.stringify(ordered);
const paramsHash = crypto
    .createHmac('sha256', secretKey)
    .update(stringParams)
    .digest()
    .toString('base64')
    .replace(/\+/g, '-')
    .replace(/\//g, '_')
    .replace(/=$/, '');

console.log(paramsHash === urlParams.sign);
```

Использование API | Параметры запуска приложения

# Bots Long Poll API

**Bots Long Poll API** позволяет работать с событиями из вашего сообщества в режиме реального времени. В отличие от [Callback API](api/callback/getting-started), очередь из событий хранится на стороне ВКонтакте — мы не будем присылать отдельное уведомление для каждого события. В противоположность [User Long Poll](api/user-long-poll/getting-started), Bots Long Poll API работает с событиями сообщества, а не пользователя.

Чтобы использовать Bots Long Poll API, откройте раздел **Управление сообществом**, на вкладке **Работа с API** → **Long Poll API** выберите **Включён**.

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

Перед подключением к Long Poll серверу необходимо получить данные сессии (`server`, `key`, `ts`) методом [`groups.getLongPollServer`](method/groups.getLongPollServer).

Затем составьте запрос такого вида:

```
{$server}?act=a_check&key={$key}&ts={$ts}&wait=25
```

В нём используются следующие параметры:
*  `key` — секретный ключ сессии;
*  `server` — адрес сервера;
*  `ts` — номер последнего события, начиная с которого нужно получать данные;
*  `wait` — время ожидания (так как некоторые прокси-серверы обрывают соединение после 30 секунд, мы рекомендуем указывать `wait`=`25`). Максимальное значение — `90`.

Для первого запроса в рамках сессии значения для параметров `server`, `key` и `ts` необходимо получить методом [`groups.getLongPollServer`](method/groups.getLongPollServer). В последующих запросах используйте те же `server` и `key` и новое значение `ts`, которое придет вам в ответе от Long Poll сервера.

В разделе **Управление сообществом** → **Работа с API** → **Bots Long Poll API** → **Типы событий** отметьте те события, которые вы хотите отслеживать. Полный список событий вы найдёте [на этой странице](api/community-events/json-schema).

### Настройка через API

Вы можете управлять настройками Bots Long Poll API в вашем сообществе не только в веб-интерфейсе, но и с помощью методов API:
* [`groups.getLongPollServer`](method/groups.getLongPollServer) — получает адрес для подключения к Long Poll серверу ВКонтакте;
* [`groups.getLongPollSettings`](method/groups.getLongPollSettings) — получает настройки событий Bots Long Poll API;
* [`groups.setLongPollSettings`](method/groups.setLongPollSettings) — устанавливает настройки событий Bots Long Poll API.

## Формат данных

Когда произойдет новое событие или истечет время ожидания, сервер вернет Вам ответ в формате JSON:

```JSON
{
  "ts": "4",
  "updates": [
    {
      "type": "wall_post_new",
      "event_id": "c68dfb983247fea8ac98ea0ea59717df71d8064f",
      "v": ":version",
      "object": {
        "id": 28,
        "from_id": -123456,
        "owner_id": -123456,
        "date": 1519631591,
        "marked_as_ads": 0,
        "post_type": "post",
        "text": "Post text",
        "can_edit": 1,
        "created_by": 564321,
        "can_delete": 1,
        "comments": {
          "count": 0
        }
      },
      "group_id": 123456
    }
  ]
}
```

JSON-объект в ответе содержит два поля:
* `ts` (`string`) — номер последнего события. Используйте его в следующем запросе.
* `updates` (`array`) — массив, элементы которого содержат представление новых событий. 

После получения любого ответа для продолжения связи нужно отправить запрос с новым `ts`, полученным в последнем ответе.   

### Типы событий

Событие в массиве `updates` представляет собой JSON, имеющий следующую структуру:

```JSON
{
  "type": <тип события>,
  "event_id": <идентификатор события>,
  "v": <версия API, для которой сформировано событие>,
  "object": <объект, инициировавший событие>,
  "group_id": <ID сообщества, в котором произошло событие>
}
```

Например:

```JSON
{
  "type": "group_join",
  "event_id": "c68dfb983247fea8ac98ea0ea59717df71d8064f",
  "v": ":version",
  "object": {
    "user_id": 1,
    "join_type": "approved"
  },
  "group_id": 1
}
```

Структура событий в Bots Long Poll API идентична событиям в Callback API. Полный список событий вы найдёте [на этой странице](api/community-events/json-schema).

### Ошибки

В ответ на запрос сервер может вернуть одну из ошибок:

```JSON
{
  "failed": 1,
  "ts": 30
}
```
```JSON
{
  "failed": 2
}
```
```JSON
{
  "failed": 3
}
```

* `"failed":1` — история событий устарела или была частично утеряна, приложение может получать события далее, используя новое значение `ts` из ответа.
* `"failed":2` — истекло время действия ключа, нужно заново получить `key` методом [`groups.getLongPollServer`](method/groups.getLongPollServer).
* `"failed":3` — информация утрачена, нужно запросить новые `key` и `ts` методом [`groups.getLongPollServer`](method/groups.getLongPollServer).

Обратите внимание: объекты в сообщении об ошибке могут содержать поля, не описанные  в документации. Их необходимо игнорировать и не обрабатывать. 

## Поддержка в SDK

Вы можете работать с Bots Long Poll API средствами наших SDK:
* [Java SDK](sdk/java),
* [PHP SDK](sdk/php),
* [Node.js SDK](https://github.com/Naltox/node-vk-sdk) (неофициальный).

Интеграция | Сообщества и пользователи | Bots Long Poll API

# Клавиатура

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

Чтобы включить клавиатуры в сообществе, перейдите в **Управление сообществом** → **Сообщения** → **Настройки для бота** и включите **Возможности ботов**. Там же можно добавить кнопку **Начать**. 

## Кнопка «Начать»

Если она включена, и у пользователя еще нет переписки с сообществом, мы показываем кнопку «Начать», которая отправляет команду `start`. [Payload](#Отправка%20клавиатуры) этого сообщения будет выглядеть так: 

```
{"command":"start"}
```

## Внешний вид

Клавиатура представляет собой массив массивов, то есть таблицу, у которой ячейки — это кнопки. У всех кнопок в рамках одной строки одинаковый размер, и они заполняют 100% ширины. Высота всех кнопок — константа. Текст отображается по центру кнопки и обрезается, если не помещается полностью при текущем размере экрана. 

### Стандартное отображение

По умолчанию, если не передан параметр `inline`, клавиатура показывается под полем ввода в диалоге с пользователем. Максимальный размер стандартной клавиатуры — 5 × 10. Максимальное количество клавиш: 40. 

![](23da71d33405de08fec50d8805eb69fbf7024196a16dad3d328de21b "616200134238115590")

### Inline-отображение

Клавиатура может отображаться внутри сообщения — это inline-отображение. Чтобы включить его, передайте параметр inline в объект клавиатуры. Её максимальный размер составит 5 × 6. Максимальное количество клавиш: 10. 

![](ea51b7f45bf0a0d0c1d393d5990e6e51728c00ddb5ab984134578f1a "6537326869192998723")

## Структура данных

### `one_time`
`bool`
Скрывать ли клавиатуру после первого использования. Параметр срабатывает только для кнопок, отправляющих сообщение (поле `type` - `text, location`) Для `type` равных `open_app`, `vk_pay` параметр игнорируется. 
Возможные значения:
* `true` — клавиатура будет скрыта при нажатии на кнопку с типом `text` или `location`;
* `false` — клавиатура не скрывается; 

### `buttons`

`array`
Массив массивов с кнопками. 

### `inline`

`bool`
Должна ли клавиатура отображаться внутри сообщения. Возможные значения:
*  `true` — клавиатура отображается внутри сообщения. Параметр `one_time` при этом не поддерживается;
*  `false` — стандартное отображение клавиатуры.

### `action`

`object`
Объект, описывающий тип действия и его параметры. Поля объекта зависят от значения параметра `type` и описаны в таблице ниже.

### `color`

`string`
Цвет кнопки. Параметр используется только для кнопок с `type`: `text` и `callback`. Возможные значения:
*  `primary` — синяя кнопка, обозначает основное действие. `#5181B8` 
*  `secondary` — обычная белая кнопка. `#FFFFFF` 
*  `negative` — опасное действие, или отрицательное действие (отклонить, удалить и тд). `#E64646` 
*  `positive` — согласиться, подтвердить. `#4BB34B`

Поля объекта `action` в зависимости от типа кнопки.

### `Text`

Текстовая кнопка. Отправляет сообщение c текстом, указанным в `label`. Поля текстовой кнопки:
* `type` (`string`) — для текстовой кнопки имеет значение `text`;
* `label` (`string`) — текст кнопки. Будет отправлен пользователем в диалог с сообществом/беседу при нажатии;
*  `payload` (`string`) — дополнительная информация. Вернется в [событии](api/community-events/json-schema) `message_new` в одноименном поле. Максимум 255 символов.

### `Open Link`

Открывает указанную ссылку. Поля:
* `type` (`string`) — для кнопки открытия ссылки имеет значение `open_link`;
* `link` (`url`) — ссылка, которую необходимо открыть по нажатию на кнопку;
* `label` (`string`) — текст кнопки;
*  `payload` (`string`) — дополнительная информация. В кнопках, не отправляющих текст, передается для совместимости со старыми клиентами. Максимум 255 символов.

### `Location`

 По нажатию отправляет местоположение в диалог с ботом/беседу. Эта кнопка всегда занимает всю ширину клавиатуры. Поля:
* `type` (`string`) — для кнопки местоположения имеет значение `location`;
* `payload` (`string`) — дополнительная информация. Вернется в [событии](api/community-events/json-schema) `message_new` в одноименном поле. Максимум 255 символов.


### `VK Pay`

Открывает окно оплаты VK Pay с предопределёнными параметрами. Кнопка называется «Оплатить через VK pay», VK pay отображается как логотип. Эта кнопка всегда занимает всю ширину клавиатуры. Поля:
* `type` (`string`) — для кнопки вызова платежного окна имеет значение `vkpay`;
* `payload` (`string`) — дополнительная информация.  В кнопках, не отправляющих текст, передается для совместимости со старыми клиентами. Максимум 255 символов.
*  `hash` (`string`) — строка, содержащая [параметры платежа VK Pay](pay/getting-started) и идентификатор приложения в параметре `aid` , разделенные `&`. Пример: `action=transfer-to-group&group_id=1&aid=10`.

### `VK Apps`

Открывает указанное приложение VK Apps. Эта кнопка всегда занимает всю ширину клавиатуры. Поля:
* `type` (`string`) — для кнопки открытия сервиса имеет значение `open_app`;
* `app_id` (`int`) — идентификатор вызываемого приложения с типом VK Apps.  
* `owner_id` (`int`) — идентификатор сообщества, в котором установлено приложение, если требуется открыть в контексте сообщества;
* `payload` (`string`) — дополнительная информация.  В кнопках, не отправляющих текст, передается для совместимости со старыми клиентами. Максимум 255 символов.
* `label` (`string`) — название приложения, указанное на  кнопке. 
* `hash` (`string`) — хеш для навигации в приложении, будет передан в строке параметров запуска после символа `#`.

### `Callback`

Позволяет без отправки сообщения от пользователя получить уведомление о нажатии на кнопку и выполнить необходимое действие.  Поля:
* `type` (`string`) — для callback-кнопки имеет значение `callback`;
* `label` (`string`) — текст кнопки. 
*  `payload` (`string`) —  дополнительная информация. В кнопках, не отправляющих текст, передаётся для совместимости со старыми клиентами. Максимум 255 символов. Подробнее читайте в разделе [Callback-кнопки](api/bots/development/keyboard#Callback-кнопки).

### Пример клавиатуры в JSON

```JSON
{  
   "one_time":false,
   "buttons":[  
      [  
         {  
            "action":{  
               "type":"location",
               "payload":"{\"button\": \"1\"}"
            }
         }
      ],
      [  
         {  
            "action":{  
               "type":"open_app",
               "app_id":6232540,
               "owner_id":-157525928,
               "hash":"123",
               "label":"LiveWidget"
            }
         }
      ],
      [  
         {  
            "action":{  
               "type":"vkpay",
               "hash":"action=transfer-to-group&group_id=181108510&aid=10"
            }
         }
      ],
      [  
         {  
            "action":{  
               "type":"text",
               "payload":"{\"button\": \"1\"}",
               "label":"Red"
            },
            "color":"negative"
         },
         {  
            "action":{  
               "type":"text",
               "payload":"{\"button\": \"2\"}",
               "label":"Green"
            },
            "color":"positive"
         },
         {  
            "action":{  
               "type":"text",
               "payload":"{\"button\": \"2\"}",
               "label":"Blue"
            },
            "color":"primary"
         },
         {  
            "action":{  
               "type":"text",
               "payload":"{\"button\": \"2\"}",
               "label":"White"
            },
            "color":"secondary"
         }
      ]
   ]
}
```

## Отправка клавиатуры

JSON-объект клавиатуры передается строкой в параметре `keyboard` в методе [`messages.send`](method/messages.send) с последней версией API. 

Как только пользователь нажимает на одну из кнопок клавиатуры, отправляется сообщение с текстом из поля `label`. Если задан параметр `payload`, он дополнительно придет в callback API. 

> **Важное замечание**: чтобы получать параметр `payload`, нужно поднять версию callback API до 5.69 или выше. Параметр `payload` нужно передавать в формате JSON.

## Пример события в Callback API

```JSON
{
    "type": "message_new",
    "object": {
        "id": 41,
        "date": 1526898082,
        "out": 0,
        "user_id": 163176673,
        "read_state": 0,
        "title": "",
        "body": "Blue",
        "payload": "{\"button\":\"4\"}"
    },
    "group_id": 1
}
```

Также, если клавиатура была определена с флагом `one_time`, она сразу же скрывается. Если нет, остается как была и пользователь может отправить еще сколько угодно команд.
Чтобы убрать у пользователя клавиатуру, необходимо отправить сообщение с пустым параметром `buttons`:

```JSON
{"buttons":[],"one_time":true}
```

## Callback-кнопки

Callback-кнопки — тип кнопок, который работает в стандартном и в inline-отображении клавиатур ботов.

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

### Примеры использования

* Реализация основного меню бота: после нажатия на callback-кнопку на клавиатуре бот обновляет её, выполняя переход на уровень глубже по вложенности меню. При этом пользователю не нужно отправлять боту дополнительное сообщение.
* Редактирование сообщения: пользователь нажимает на callback-кнопку в inline-клавиатуре из сообщения, выбирая категорию блюда в меню, — бот редактирует сообщение, предлагая блюда из этой категории. Пользователь при этом не отправляет боту сообщение.
* Отправка результата действия: пользователь нажимает на callback-кнопку, например «Пополнить баланс», которая совершает определённое действие. После его успешного выполнения бот показывает пользователю информацию «Баланс пополнен» при помощи snackbar. Отправка сообщения при этом не требуется.

### Принцип работы

```JSON
{
  action: {
    type: "callback",
    payload: "{}", // максимум 255 символов
    label: "Нажми меня"
  }
}
```
* пользователь нажимает на клавишу;
* бот получает новое событие `message_event` в Callback или LongPoll API:
```JSON
{
  "conversation_message_id": 1234,
  "user_id": 612512941,   // id пользователя, который нажал на кнопку
  "peer_id": 2000000094, // id диалога со стороны бота
  "event_id": "feleyinek", // Случайная строка. Активна в течение минуты, спустя минуту становится недействительной
  "payload": "{}"
}
```
* бот формирует запрос к API, используя метод [`messages.sendMessageEventAnswer`](method/messages.sendMessageEventAnswer);
* клиент пользователя получает ответ от бота и выполняет нужное действие.

### Действие после нажатия на кнопку

Бот отправляет `event_data` — объект действия, которое должно произойти после нажатия на кнопку.
```JSON
{
    "type": "show_snackbar",
    "text": "Покажи исчезающее сообщение на экране"
  }
```
Метод [`messages.sendMessageEventAnswer`](method/messages.sendMessageEventAnswer) можно выполнить только один раз за нажатие на клавишу.  

### Типы действий

1. `show_snackbar` — показать исчезающее сообщение.
    Содержит поле `text` — текст, который нужно вывести (максимум 90 символов). Snackbar показывается в течение 10 секунд и автоматически скрывается, при этом у пользователя есть возможность смахнуть его с экрана.
    ![](de951d983e604c2aabe128a8e5e1ccb37de792b2b582d9ca221db1dc "-3563741600283602501")
2. `open_link` — открыть ссылку. Осуществляется переход по указанному адресу.
    ```JSON
    {
      type: "open_link",
      link: url
    }
    ```
3. `open_app` — открыть VK Mini App. Происходит переход в мини-приложение.
    ```JSON
    {
      type: "open_app",
      app_id: int,
      owner_id: int | null,
      hash: string
    }
    ```
### Внешний вид

Callback-кнопки выглядят так же, как и обычные кнопки, и поддерживают все стили. После нажатия на кнопку на время выполнения действия возникает индикатор загрузки.
![](2ded1e4a35c7dae08f9d64009478dee14f2498cd1876683b67a36bcf "-532726193596602097")

### Обработка ошибок

Если в формате объекта клавиатуры есть ошибки, [`messages.send`](method/messages.send) вернёт ошибку `911. Keyboard format is invalid`.

Интеграция | Чат-боты | Разработка | Клавиатура

Интеграция | Чат-боты | Разработка | Сообщения

# Быстрый старт

**Чат-бот** — это скрипт на вашем сервере, который получает уведомления о новых событиях из ВКонтакте и обрабатывает их. Например, определяет текстовую команду в сообщении от пользователя и присылает в ответ какое-нибудь изображение.

Для создания бота вам потребуются:
*  Сообщество, от имени которого ваш бот будет общаться с пользователями ВКонтакте.
*  Сервер, который будет принимать уведомления о событиях.
*  Логика самого бота — скрипт, который определяет, как бот реагирует на то или иное событие.

В первую очередь вам нужно продумать функциональность чат-бота. Составьте список возможных текстовых команд или событий, на которые бот должен реагировать, и соответствующие им ответные действия бота. Стоит помнить, что люди могут ошибаться, набирая команды, и присылать боту текст, который отличается от всех учтённых вами вариантов — важно предусмотреть действие по умолчанию (можно в таком случае присылать пользователю список всех поддерживаемых команд).

> Если ранее вы не работали с API ВКонтакте, перед началом работы мы рекомендуем вам прочитать [это руководство](api/getting-started).


## Примеры реализации

### PHP

[VK PHP Бот](https://vk.com/botexample), созданный нашим разработчиком на PHP. Для обработки событий используется Callback API, голосовые сообщения генерируются с помощью API [Яндекс SpeechKit](https://tech.yandex.ru/speechkit/). [Код проекта на GitHub](https://github.com/VKCOM/bot-example-php). 

### Java

Бот для работы с Youtrack, созданный нашими разработчиками на Java ([Java SDK](sdk/java)). Для обработки событий используется Callback API. [Код проекта на GitHub](https://github.com/VKCOM/vk-java-sdk/wiki/YouTrack-bot). 

### JS

Библиотека для работы с ботами на Node JS, автор [Михаил Семин](https://vk.com/bifot). Используется Long Poll, предусмотрена возможность быстро и удобно добавлять новые команды и реакции. [Код проекта на GitHub](https://github.com/bifot/node-vk-bot-api). 

## Сообщество

Для подключения чат-бота вы можете использовать любое своё сообщество ВКонтакте — группу, встречу или публичную страницу. Ваш бот должен соответствовать правилам, подробнее о них вы можете узнать [здесь](bots-rules).

Первым делом нужно указать, что в вашем сообществе будет работать бот. Для этого перейдите в **Управление сообществом** → **Сообщения** → **Настройки для бота** и включите пункт **Возможности ботов**.

Сообщество — это точка входа для пользователей, которые будут общаться с вашим ботом. Стоит позаботиться о том, чтобы оно выглядело привлекательно и содержало описание вашего бота, иначе его действия могут стать сюрпризом для пользователей. Не забудьте включить сообщения в вашем сообществе (**Управление сообществом** → **Сообщения**), когда бот будет готов к использованию, чтобы ему можно было написать. 

Итак, если вы выбрали сообщество, можно приступать к настройке уведомлений.

### Получение ключа доступа

Ключ доступа потребуется вам для получения обновлений (в Long Poll), а также для работы с API. 

Откройте раздел **Управление сообществом** (**Управление страницей**, если у вас публичная страница), выберите вкладку **Работа с API** и нажмите  **Создать ключ доступа**.

Отметьте необходимые права доступа и подтвердите свой выбор. 

![](94dbda6f9957847362a13776b0676208b2cedee8d63b617201bc5742 "-8033473622113514247")

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

Также вы можете получить ключ доступа с помощью OAuth. Используйте схему авторизации [Authorization Code Flow](api/access-token/authcode-flow-user).

### Добавление ботов в беседы

Чтобы пользователи смогли добавлять бота в беседы, необходимо включить эту возможность в настройках. Перейдите в **Управление сообществом** →**Сообщения** →**Настройки для бота** и поставьте галочку в пункте **Разрешать добавлять сообщество в беседы**. После этого в  сообществе появится кнопка **Пригласить в беседу**, открывающая модальное окно со списком бесед.

Сейчас у бота в беседе есть три уровня доступа:

#### Только упоминания

Этот уровень доступа выдается сразу после добавления в беседу. Бот может:
*  видеть все сообщения, которые его касаются. Это упоминания бота и ответы на его сообщения
*  отправлять сообщения в беседу

#### Доступ ко всей переписке

Выдать его может любой администратор беседы. Бот может:
*  видеть все сообщения в беседе 
*  отправлять сообщения в беседу

#### Администратор

Выдать его может только создатель беседы. Бот может:
*  видеть все сообщения в беседе 
*  отправлять сообщения в беседу
*  Получать [объект беседы](reference/objects/conversation)
*  Получать участников беседы

>  **Важно!** Для получения событий из беседы версия API у callback-сервера должна быть не ниже 5.80.

## Получение событий и обновлений

Чтобы реагировать на какие-либо события, ваш скрипт должен о них узнать. Для этого существуют два подхода — Callback API и Long Poll.

### Callback API

Callback API присылает уведомления на ваш сервер, как только в сообществе происходит нужное событие. Событие может быть каким угодно: комментарий к фотографии, новая запись на стене, вступление в сообщество, отправка сообщения, и многое другое. Посмотреть полный список доступных событий, а также прочитать подробнее о настройке вы можете [в документации Callback API](api/callback/getting-started).

Для подключения Callback API в сообществе нужно указать адрес скрипта на вашем сервере и выбрать события, которые Вы хотите получать. Например, если ваш бот должен распознавать текстовые команды, отметьте событие **Входящее сообщение**.

Уведомления от Callback API выглядят как JSON с основной информацией о событии:
```JSON
{  
   "type":"message_new",
   "object":{  
      "id":694,
      "date":1499441696,
      "out":0,
      "user_id":123456,
      "read_state":0,
      "title":" ... ",
      "body":"start"
   },
   "group_id":1,
   "secret":"sjr948dff3kjnfd3"
}
```
В этом примере пользователь с `id` = `123456` отправил сообществу сообщение с текстом `start`. 

Для каждого события Callback API отправляет отдельный запрос на ваш сервер. Ваш скрипт должен подтверждать получение каждого запроса, отправляя в ответ строку `ok`.

### Пример на PHP
```PHP
<?
define('CALLBACK_API_CONFIRMATION_TOKEN', '213fefef3');  // Строка, которую должен вернуть сервер
define('VK_API_ACCESS_TOKEN', '016cb552 ... 989fb8345');   // Ключ доступа сообщества

define('CALLBACK_API_EVENT_CONFIRMATION', 'confirmation'); // Тип события о подтверждении сервера
define('CALLBACK_API_EVENT_MESSAGE_NEW', 'message_new'); // Тип события о новом сообщении
define('VK_API_ENDPOINT', '[https://api.vk.com/method/]');   // Адрес обращения к API
define('VK_API_VERSION', '5.89'); // Используемая версия API

$event = json_decode(file_get_contents('php://input'), true);

switch ($event['type']) {
  // Подтверждение сервера
  case CALLBACK_API_EVENT_CONFIRMATION:
    echo(CALLBACK_API_CONFIRMATION_TOKEN);
    break;
  // Получение нового сообщения
  case CALLBACK_API_EVENT_MESSAGE_NEW:
    $message = $event['object'];
    $peer_id = $message['peer_id'] ?: $message['user_id'];
    send_message($peer_id, "Hello world! (peer_id: {$peer_id})");
    echo('ok');
    break;
  default:
    echo('Unsupported event');
    break;
}

function send_message($peer_id, $message) {
  api('messages.send', array(
    'peer_id' => $peer_id,
    'message' => $message,
  ));
}

function api($method, $params) {
  $params['access_token'] = VK_API_ACCESS_TOKEN;
  $params['v']            = VK_API_VERSION;
  $query                  = http_build_query($params);
  $url                    = VK_API_ENDPOINT . $method . '?' . $query;
  $curl                   = curl_init($url);
  curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
  $json  = curl_exec($curl);
  $error = curl_error($curl);
  if ($error) {
    error_log($error);
    throw new Exception("Failed {$method} request");
  }
  curl_close($curl);
  $response = json_decode($json, true);
  if (!$response || !isset($response['response'])) {
    error_log($json);
    throw new Exception("Invalid response for {$method} request");
  }
  return $response['response'];
}
```
[Скрипт полностью на GitHub](https://github.com/VKCOM/bot-example-php)

### Bots Long Poll API

Второй способ получения обновлений — это подключение к Bots Long Poll API. Прочитать подробнее о работе с Bots Long Poll API вы можете [на этой странице](api/bots-long-poll/getting-started).

Когда произойдет новое событие или истечет время ожидания, сервер вернет вам ответ в формате JSON:

```JSON
{
  "ts": "4",
  "updates": [
    {
      "type": "wall_post_new",
      "object": {
        "id": 28,
        "from_id": -123456,
        "owner_id": -123456,
        "date": 1519631591,
        "marked_as_ads": 0,
        "post_type": "post",
        "text": "Post text",
        "can_edit": 1,
        "created_by": 564321,
        "can_delete": 1,
        "comments": {
          "count": 0
        }
      },
      "group_id": 123456
    }
  ]
}
```

### Информация о доступных пользователю функциях

Некоторые функции ботов могут быть недоступны, так как пользователи:
*  переходят на новые версии официальных приложений ВКонтакте постепенно;
*  открывают ВКонтакте на разных платформах (iOS, Android, в мобильной и веб-версии);
*  используют приложения от сторонних разработчиков. Например, клавиатура ботов может быть недоступна в старой версии официального приложения ВКонтакте.

Отправляйте сообщения в нужном формате, исходя из возможностей, которые доступны пользователю. Если он не может воспользоваться клавиатурой, предложите варианты ответов и пронумеруйте их — чтобы можно было ответить цифрой. И наоборот: если пользователь может взаимодействовать с ботом с помощью клавиатуры — не нужно отправлять ему варианты ответа в тексте сообщения.

Начиная с версии API 5.103 информация о доступных функциях будет приходить вместе с событием [`message_new`](api/community-events/json-schema) в Callback API и Bots Long Poll API. Она будет находиться в объекте `client_info`:

```JSON
"client_info": { 
    "button_actions": [ 
      "text", 
      "vkpay", 
      "open_app", 
      "location", 
      "open_link", 
      "callback" 
    ], 
    "keyboard": true, 
    "inline_keyboard": true, 
    "carousel": false, 
    "lang_id": 0 
} 
```

По мере появления новых возможностей в объекте `client_info` и массиве `button_actions` могут появляться новые сущности.

Поля объекта:
*  `button_actions` — массив кнопок, которые поддерживает клиент. Возможные значения смотрите в разделе [Клавиатура](api/bots/development/keyboard#Структура%20данных);
*  `keyboard` (`bool`) — поддерживается ли клавиатура ботов клиентом;
*  `inline_keyboard` (`bool`) — поддерживается ли inline-клавиатура ботов клиентом;
*  `carousel` (`bool`) — поддерживаются ли [карусели](api/bots/development/messages) клиентом;
*  `lang_id` — [ID](api/api-requests) используемого языка.

Интеграция | Чат-боты | Быстрый старт

# Боты для сообществ

**Бот** — это программа, которая имитирует некоторые действия человека. С его помощью можно автоматизировать рутинные задачи. 

Они нужны там, где есть много похожих действий, которые сейчас выполняются руками (или не выполняются вовсе — просто потому что нет столько рук).

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

![](47b0490c93d3c32d6c544be551a8806fe61b18d0ea3a07e85e0fcb85 "-5636580476323788944")

ВКонтакте боты общаются с вашими клиентами через [сообщения сообществ](api/community-messages/getting-started).
Это простой и привычный для пользователя интерфейс.

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

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

> Бот может стать дополнительным средством для привлечения внимания к сообществу. Создавайте интерактивные квесты, присылайте подписчикам мультимедиа-материалы, подключайте сторонние API для реализации игровых сценариев — пользователи не пройдут мимо интересных предложений.


## Преимущества платформы

### Социальный граф

ВКонтакте вы можете работать с социальным графом, анализируя связи и интересы пользователя. Например, для создания рекомендательной системы или сервиса персональной инфографики.

### Мультимедиа

Огромная библиотека медиаконтента, который можно использовать для создания подборок фотографий, видео или аудиозаписей.

### Кроссплатформенность

Сообщения сообществ работают в полной и мобильной версиях, а также во всех официальных клиентах. Это значит, что пользователь может взаимодействовать с ботом на любой платформе.

## Документация

Чтобы научиться создавать ботов ВКонтакте, прочитайте [Быстрый старт](api/bots/getting-started).

## Примеры ботов

* Бот [РБК](https://vk.com/rbc) предлагает подписаться на рассылку актуальных новостей, умеет принимать жалобы на опечатки и решает вопросы, связанные с размещением рекламы.
* Бот принимал обращения от граждан в рамках [Прямой линии с Владимиром Путиным](https://vk.com/moskvaputinu).
* Бот [Vinci](https://vk.com/vinci) обрабатывает присланную фотографию с помощью хитрых алгоритмов и предлагает подходящие теги и Emoji для подписи.

:::carousel
![title=Бот РБК предлагает подписаться на рассылку актуальных новостей, умеет принимать жалобы на опечатки и решает вопросы, связанные с размещением рекламы.](bd62819e0364f07d86ec1137cb419a1bda0aa63058cd4a7e657592d2 "-3327336004805555787")
![title=Бот принимал обращения от граждан в рамках Прямой линии с Владимиром Путиным.](60fac052a021f365547cc1655b896ebab720dd620b13c44658233f3f "-4939451182648991171")
![Бот Vinci обрабатывает присланную фотографию с помощью хитрых алгоритмов и предлагает подходящие теги и Emoji для подписи.](3b415358de0139ef4e6477cf045321cb9c20ca02f52f3ddc270a4caa "7598733202427498813")
:::

Интеграция | Чат-боты | Боты для сообществ

Интеграция | Сообщества и пользователи | Callback API

# Ошибка с Captcha

Если какое-либо действие (например, отправка сообщения) выполняется пользователем слишком часто, то запрос к API может возвращать ошибку `"Captcha needed"`. При этом пользователю понадобится ввести код с изображения и отправить запрос повторно с передачей введенного кода [Captcha](https://ru.wikipedia.org/wiki/CAPTCHA) в параметрах запроса.
```JSON
{
  "error_code": 14,
  "error_msg": "Captcha needed"
}
```
Если возникает данная ошибка, то в сообщении об ошибке передаются также следующие параметры:
* `captcha_sid` — идентификатор `captcha`.
* `captcha_img` — ссылка на изображение, которое нужно показать пользователю, чтобы он ввел текст с этого изображения.

В этом случае следует запросить пользователя ввести текст с изображения `captcha_img` и повторить запрос, добавив в него параметры:
* `captcha_sid` — полученный идентификатор
* `captcha_key` — текст, который ввел пользователь
## Пример ошибки
```JSON
{
  "error":
  {
      "error_code":14,
      "error_msg":"Captcha needed",
      "request_params":
      [{
        "key":"oauth",
        "value":"1"
      },{
        "key":"method",
        "value":"captcha.force"
      },{
        "key":"uids",
        "value":"66748"
      },{
        "key":"access_token",
        "value":"b9b5151856dcc745d785a6b604295d30888a827a37763198888d8b7f5271a4d8a049fefbaeed791b2882"
      }], 
    "captcha_sid":"239633676097",
    "captcha_img":"http:\/\/api.vk.com\/captcha.php?sid=239633676097&s=1"
  }
}
```

Использование API | Обработка ошибок | Ошибка с Captcha

# Виджеты сообществ

Виджет представляет собой  отрисованный в соответствии с формальным описанием блок с информацией: например, список ресторанов или кинотеатров, результаты футбольного матча или киберспортивного поединка, перечень цен на услуги или объекты недвижимости. Блок с виджетом будет находиться в верхней части сообщества и доступен как в полной версии сайта, так и в мобильных клиентах.

Установка виджетов доступна из приложений, которые поддержали у себя эту возможность. Например: «Рассылки», «Тесты», «Пожертвования», «Заявки», «Анкеты», «Магазин товаров» и «Цитаты» (Все они доступны в официальном каталоге приложений: [vk.com/community_apps](https://vk.com/community_apps) ).

 ![title=Виджет Cover List](89451c8f61192a8e0602c173a42ab3fc6a00d1c5ed8dda941c67f482 "-5550232801630865703") 

> В виджете можно отображать список матчей, таблицу, цитату и многое другое. Все доступные типы виджетов подробно описаны [на этой странице](reference/objects/app-widget).

## Шаг 1. Получение ключа доступа

Для работы с виджетами в сообществе необходимо получить токен сообщества с правом доступа `app_widget` при помощи события VK Bridge [`VKWebAppGetCommunityToken`](bridge/VKWebAppGetCommunityToken) в приложении с типом VK Mini Apps.

## Шаг 2. Генерация виджета

Для генерации виджета и его обновления используйте метод  API [`appWidgets.update`](method/appWidgets.update). В качестве аргументов он принимает:
* `type` (`string`) — тип виджета. Может принимать значения `text`, `list`, `table`, `tiles`, `compact_list`, `cover_list`, `match`, `matches`, `donation`.
* `code` (`string`) — код виджета. Аналог параметра`code` в методе [`execute`](method/execute).

Синтаксис вызова методов API можно найти [здесь](api/api-requests).

### Базовые переменные

Переменная `Args` содержит в себе данные, которые могут пригодиться для отрисовки виджета:
*  `Args.uid` — идентификатор текущего пользователя.
*  `Args.platform` — тип платформы, с которой открыта группа:
   *  `web`
   *  `mobile`
   *  `android`
   *  `iphone`
*  `Args.lang` — идентификатор языка пользователя:
   *  `0` — русский
   *  `1` — украинский
   *  `2` — белорусский
   *  `3` — английский
   *  `4` — испанский
   *  `5` — финский
   *  `6` — немецкий
   *  `7` — итальянский

Внутри `code` можно использовать ограниченный набор методов API, по умолчанию используется версия API 5.100.

* [`users.get`](method/users.get)
* [`users.getSubscriptions`](method/users.getSubscriptions)
* [`users.getFollowers`](method/users.getFollowers)
* [`wall.get`](method/wall.get)
* [`wall.search`](method/wall.search)
* [`photos.getAlbums`](method/photos.getAlbums)
* [`photos.get`](method/photos.get)
* [`photos.getById`](method/photos.getById)
* [`photos.search`](method/photos.search)
* [`friends.get`](method/friends.get)
* [`widgets.getComments`](method/widgets.getComments)
* [`widgets.getPages`](method/widgets.getPages)
* [`wall.getById`](method/wall.getById)
* [`wall.getReposts`](method/wall.getReposts)
* [`wall.getComments`](method/wall.getComments)
* [`groups.isMember`](method/groups.isMember)
* [`groups.getById`](method/groups.getById)
* [`groups.getMembers`](method/groups.getMembers)
* [`board.getTopics`](method/board.getTopics)
* [`board.getComments`](method/board.getComments)
* [`likes.getList`](method/likes.getList)
* [`apps.getCatalog`](method/apps.getCatalog)
* [`apps.get`](method/apps.get)



`code` должен возвращать JSON-объект, описывающий виджет. Элементы виджета могут содержать только внутренние ссылки на vk.com (кроме away.php) и vk.me. 

В общем случае параметр `code` выглядит так:

```JSON
return {
    '''widget'''
};
```

Структура объекта `widget` зависит от типа виджета, подробное описание вы найдёте [на этой странице](reference/objects/app-widget).

Обновлять данные виджета через приложение можно не чаще 1 раза в 30 секунд.

![](6afc6ad9b639c9c32b833769889e9f7ce727c254d1e32abcfcb1f4c9 "-5747787520618281419")

Чтобы скрыть виджет у пользователя, передайте в `code` значение `"return false"`.  

## Изображения в виджете

В виджете могут быть использованы изображения из двух коллекций — относящиеся к приложению (для использования в разных сообществах) и к сообществу (для использования в одном конкретном сообществе). 

Для загрузки изображений нужно использовать соответственно методы API:
* [`appWidgets.getGroupImageUploadServer`](method/appWidgets.getGroupImageUploadServer),
* [`appWidgets.getAppImageUploadServer`](method/appWidgets.getAppImageUploadServer),
* [`appWidgets.saveGroupImage`](method/appWidgets.saveGroupImage),
* [`appWidgets.saveAppImage`](method/appWidgets.saveAppImage).

Необходимо загружать изображения в утроенном размере (например, для картинки с конечным размером 160x160 нужно загружать изображение размером 480x480).

> **Важно!** Вы можете использовать главные фотографии профилей, сообществ и других приложений внутри виджета. Для этого передайте в поле `icon_id` для квадратного изображения значение `id123456` — для главной фотографии профиля пользователя с id 123456, `club123456` — для сообщества или `app123456` — для приложения. В этом случае во всех аналогичных полях виджета также должны использоваться главные фотографии (соответственно, пользователей, сообществ или приложений).

Интеграция | Сообщества и пользователи | Виджеты сообществ

Интеграция | Сообщества и пользователи | События в сообществах

# Сообщения сообществ

Сообщения сообществ — сервис для прямого диалога между пользователем и сообществом ВКонтакте. 

![](45ee4961609a0b9362f7cedaf27e3c682d2e5bdb2f0e1304b6bf6486 "-5881812424441223520")

Это удобно для ваших клиентов. Не нужно искать форму обратной связи, проходить регистрацию, отвечать через email — никаких лишних действий.

Это удобно для вас. Вместе с сообщением вы получаете все необходимые данные о его авторе, можете автоматически обрабатывать типовые заявки и мгновенно отвечать на сообщения с помощью бота.

Миллионы пользователей предпочитают общаться с друзьями, близкими и деловыми партнерами именно ВКонтакте. Используя сервис сообщений, вы можете стать ближе к клиентам и поддерживать тесную связь с ними в привычном для них окружении.

Сообщения сообществ работают в полной и мобильной версиях ВКонтакте, а также во всех официальных приложениях:  с вашей компанией можно связаться на любой платформе.

![](7bc2a650a8d1ec1313f0acc698c6b3302a648aaea8b8102b6618e049 "9214525706664327534")

Подробнее обо всех преимуществах для бизнеса мы рассказали на [отдельной странице](https://vk.com/page-19542789_51260895).

## API для сообщений сообществ

В этом руководстве рассказывается о том, как использовать API для работы с сообщениями сообществ. 

## Ключ доступа

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

Ключ доступа — это строка, включающая латинские буквы и цифры. Ее необходимо передавать в параметре `access_token`, обращаясь к методам API от имени сообщества.

## Получение ключа доступа в настройках сообщества

Откройте раздел **Управление сообществом** (**Управление страницей**, если у вас публичная страница), выберите вкладку **Работа с API** и нажмите  **Создать ключ доступа**.

Отметьте необходимые права доступа и подтвердите свой выбор. 
![](94dbda6f9957847362a13776b0676208b2cedee8d63b617201bc5742 "-8033473622113514247")

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

## Получение ключа доступа на oauth.vk.com

Мы предлагаем два способа авторизации, основанных на протоколе OAuth 2.0. Используйте этот подход, если необходимо работать со многими сообществами пользователя, например, при разработке мобильного приложения. 

Для работы с API с серверной стороны используйте [Authorization Code Flow](api/access-token/authcode-flow-community).

Для работы с API со стороны клиента используйте [Implicit Flow](api/access-token/implicit-flow-community).

## Работа с сообщениями

В API сообщений сообществ используются те же методы, что и для работы с личными сообщениями пользователя. Если раньше вы уже имели дело с сообщениями в API ВКонтакте, схема работы будет вам знакома. Стоит, однако, учитывать некоторые особенности:
*  необходимо проставлять статус прочитанности сообщения при общении с клиентом; 
*  если ответ получен пользователем, его необходимо помечать как прочитанный; 
*  в диалогах сообществ доступны специальные метки: **Важные**, **Неотвеченные**, **Непрочитанные**. 

Чтобы вы могли отправлять пользователю сообщения от имени сообщества, пользователь должен разрешить их получение. Если пользователь написал сообщение сообществу первым, это приравнивается к согласию на получение ответных сообщений (без ограничений по времени, если пользователь не запретил сообщения вручную). Чтобы запросить у пользователя разрешение на отправку сообщений, используйте:
*  Метод [`showAllowMessagesFromCommunityBox`](sdk/javascript#showAllowMessagesFromCommunityBox) Client API в приложениях сообществ;
*  Метод [`messages.allowMessagesFromGroup`](method/messages.allowMessagesFromGroup) в Standalone-приложениях;
*  Виджет [Разрешить писать сообществу](widgets/allow-messages-from-community) на внешнем сайте.

В [Callback API](api/callback/getting-started) и [Bots Longpoll API](api/bots-long-poll/getting-started) события `message_allow` и `message_deny` помогут отслеживать факт разрешения и запрета сообщений от сообщества. **Обратите внимание**, получить список всех пользователей, разрешивших сообщения сообществу, через API нельзя, необходимо хранить и синхронизировать этот список на своей стороне.

## Доступные инструменты и методы

*  [Long Poll сервер](api/user-long-poll/getting-started) — синхронизация обновлений; 
*  [Callback API](api/callback/getting-started) — мгновенные оповещения о новых сообщениях и других действиях пользователей в сообществе.
*  [`messages.getDialogs`](method/messages.getDialogs) — метод для получения списка диалогов; 
*  [`messages.markAsRead`](method/messages.markAsRead) — метод для присвоения сообщению метки **Прочитано**;
*  [`messages.markAsImportantDialog`](method/messages.markAsImportantDialog), [`messages.markAsAnsweredDialog`](method/messages.markAsAnsweredDialog) — методы для присвоения меток диалогам;
*  [`messages.send`](method/messages.send) — метод для отправки нового сообщения;
*   [`messages.delete`](method/messages.delete), [`messages.deleteDialog`](method/messages.deleteDialog), [`messages.restore`](method/messages.restore) — методы для удаления и восстановления сообщений и диалогов;
*  [`messages.search`](method/messages.search) — метод для поиска по сообщениям;
*  [`messages.allowMessagesFromGroup`](method/messages.allowMessagesFromGroup), [`messages.denyMessagesFromGroup`](method/messages.denyMessagesFromGroup) — методы для подписки на сообщения сообщества и запрета на получение сообщений;
*   [`docs.getWallUploadServer`](method/docs.getWallUploadServer), [`docs.save`](method/docs.save), ,  — методы для загрузки фотографий и документов.
*  [`groups.getCallbackConfirmationCode`](method/groups.getCallbackConfirmationCode), [`groups.getCallbackServerSettings`](method/groups.getCallbackServerSettings), [`groups.getCallbackSettings`](method/groups.getCallbackSettings), [`groups.setCallbackSettings`](method/groups.setCallbackSettings) — методы для работы с настройками Callback API.

## Получение списка диалогов

Метод [`messages.getDialogs`](method/messages.getDialogs). 

Параметр `start_message_id` используется для защиты от смещения из-за новых сообщений при подгрузке старых диалогов. При первом вызове не передавайте `start_message_id`, запомните значение `id` у сообщения в первом диалоге и используйте его в качестве `start_message_id` в последующих вызовах при подгрузке диалогов.
 
```
https://api.vk.com/method/messages.getDialogs?v=5.41&access_token=ACCESS_TOKEN&count=10&offset=0
```

## Получение новых диалогов

Метод [`messages.getDialogs`](method/messages.getDialogs). 

Передавайте в `start_message_id` значение `id` сообщения в первом диалоге, в `count` максимальное количество новых диалогов, а в `offset`, соответственно, отрицательное значение. 

```
https://api.vk.com/method/messages.getDialogs?v=5.41&access_token=ACCESS_TOKEN&count=10&unread=1&offset=-10&start_message_id=64
```

## Получение истории сообщений в диалоге

Метод [`messages.getHistory`](method/messages.getHistory).

Чтобы получить историю конкретного диалога, используйте параметр `peer_id`. Параметр `start_message_id` используется для защиты от смещения из-за новых сообщений при подгрузке истории. При первом вызове не передавайте `start_message_id`, `запомните` значение `id` первого сообщения из ответа и используйте его в качестве `start_message_id` в последующих вызовах. 

```
https://api.vk.com/method/messages.getHistory?v=5.41&access_token=ACCESS_TOKEN&peer_id=494075&offset=0&count=10
```

```
https://api.vk.com/method/messages.getHistory?v=5.41&access_token=ACCESS_TOKEN&peer_id=494075&offset=10&count=10&start_message_id=60
```


## Получение новых сообщений с помощью Callback API

[Callback API](api/callback/getting-started) позволяет мгновенно получать информацию о новых сообщениях в адрес сообщества.

Для работы с Callback API вам потребуется серверный скрипт для обработки уведомлений. Настройте оповещения, следуя [документации](api/callback/getting-started), среди типов событий выберите **Получение нового сообщения** (`message_new`).

ВКонтакте будет отправлять на ваш сервер оповещение о каждом новом сообщении с [объектом личного сообщения](reference/objects/message) в таком формате:

```JSON
{
  "type": "message_new",
  "object": "..."
}
```

В уведомлении содержится исчерпывающая информация о сообщении — вы можете сразу ответить на него, используя метод [`messages.send`](method/messages.send).

## Передача произвольного параметра с помощью ссылки vk.me

vk.me — это сервис коротких URL, который перенаправляет пользователей в указанный диалог. 
Ссылка имеет формат http://vk.me/{group_name}, где `group_name` —  идентификатор сообщества. К примеру, vk.me/apiclub.

Вы можете  не только создать красивую ссылку на  диалог с сообществом, но и передать в такой ссылке произвольные параметры `ref` и `ref_source`, которые вернутся в объекте сообщения в [событии](api/community-events/json-schema) `message_new` [Callback API](api/callback/getting-started)  или [Bots Long Poll API](api/bots-long-poll/getting-started), в случае если пользователь начнет или продолжит беседу по ссылке вида vk.me.

Это полезно для отслеживания эффективности ссылок, размещенных в разных каналах, или привязки пользователя к сеансу или аккаунту во внешнем приложении. В зависимости от переданного параметра можно варьировать ответы бота в сообществе.

Ссылка vk.me с дополнительными параметрами выглядит следующим образом:

```
vk.me/{group_name}?ref={ref}&ref_source={ref_source}
```

Также сработает вот такая ссылка:

```
vk.com/write-{group_id}?ref={ref}&ref_source={ref_source}
```

## Отправка изображений

Чтобы отправить изображение в сообщении, используйте параметр `attachments` в методе [`messages.send`](method/messages.send). Вы можете использовать изображение, которое уже есть на сайте ВКонтакте, либо [загрузить новое](api/upload#Загрузка%20фотографии%20в%20личное%20сообщение).


Для загрузки фотографий и документов в сообщения сообщества используйте, соответственно, методы [`photos.getMessagesUploadServer`](method/photos.getMessagesUploadServer) и [`docs.getMessagesUploadServer`](method/docs.getMessagesUploadServer). Это позволит загружать вложения для неограниченного числа собеседников.

Интеграция | Сообщества и пользователи | Сообщения сообществ

# Подтверждение действия пользователем

В некоторых случаях ВКонтакте требует запросить подтверждение действия у пользователя (только для Standalone-приложений). В этом случае будет возвращена следующая ошибка:

**Код ошибки:** 24
**Текст ошибки:** Confirmation required

В сообщении об ошибке передается также параметр `confirmation_text` — текст сообщения, который необходимо показать в стандартном окне подтверждения.

Приложение должно показать стандартное окно подтверждения с текстом из `confirmation_text` и двумя кнопками **Продолжить** и **Отмена**. В случае подтверждения действия пользователем, нужно повторить запрос с дополнительным параметром `confirm = 1`.

Использование API | Обработка ошибок | Подтверждение действия пользователем

# Прямая авторизация

> **Внимание!** 
> * Доступ к этому типу авторизации может быть получен только после предварительного согласования с администрацией ВКонтакте.
> * Для подачи заявки на получение доступа необходимо обратиться в службу поддержки по адресу [https://vk.com/support](https://vk.com/support), указав идентификатор вашего приложения. В заявке необходимо кратко описать функционал приложения.
> * В настоящий момент эта возможность есть только у платформ, не поддерживающих [стандартную авторизацию](api/access-token/implicit-flow-user). 

Доверенные приложения могут получить неограниченный по времени `access_token` для доступа к API, передав логин и пароль пользователя. 

Обратите внимание, что приложение не должно хранить пароль пользователя. 
Выдаваемый `access_token` не привязан к IP-адресу пользователя, поэтому его достаточно для последующей работы с API без повторения процедуры авторизации. 

## Параметры запроса

Для авторизации нужно послать запрос на адрес [`https://oauth.vk.com/token`](https://oauth.vk.com/token), передав следующие `POST`-параметры:

* `grant_type` (**обязательный параметр**) — тип авторизации, должен быть равен `password`.
* `client_id` (**обязательный параметр**) — id вашего приложения.
* `client_secret` (**обязательный параметр**) — секретный ключ вашего приложения.
* `username` (**обязательный параметр**) — логин пользователя.
* `password` (**обязательный параметр**) — пароль пользователя.
* `scope` — [права доступа](reference/access-rights), необходимые приложению.
* `test_redirect_uri` — использовать ли тестовую проверку. Допустимые значения:
    * `1` — инициировать тестовую проверку пользователя, используя `redirect_uri`.
    * `0` — обычная авторизация (по умолчанию).
* `v` — [Версия API](reference/versions), которую вы используете. При повышении версии пожалуйста ознакомьтесь со [списком изменений](reference/versions). Актуальная версия: **:version**.
* `2fa_supported` — передайте `1`, чтобы включить поддержку двухфакторной аутентификации.

### Пример запроса авторизации

```
https://oauth.vk.com/token?grant_type=password&client_id=1914441&client_secret=***&username=***&password=***&v=:version&2fa_supported=1
```

## Обработка дополнительных проверок аккаунта

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

```JSON
{
  "error": "need_validation",
  "error_description": "please open redirect_uri in browser",
  "redirect_uri": "https://oauth.vk.com/security_check?type=test&mid=66748&hash=23132d8b8744f8b1b2"
}
```

В этом случае необходимо открыть браузер со страницей, указанной в поле `redirect_uri` и ждать, пока пользователь будет направлен на страницу blank.html с параметром `success=1` в случае успеха и `fail=1` в случае, если пользователь отменил проверку своего аккаунта. 

Для тестового вызова проверки добавьте параметр `test_redirect_uri=1`. 

## Двухфакторная аутентификация

Если вы передали в запросе параметр `2fa_supported=1` и у пользователя включена двухфакторная аутентификация, на запрос с верными логином и паролем вернется ошибка `need_validation` со следующими полями:

* `validation_type` — тип подтверждения. Возможные значения:
    * `2fa_sms` — подтверждение через SMS;
    * `2fa_app`  — подтверждение с помощью приложения для генерации кодов.
* `phone_mask` — маска номера телефона.

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

Если возникли проблемы с получением кода из приложения или пользователь не хочет использовать приложение для генерации кодов, вы можете форсировать получение кода по SMS, повторно передав запрос авторизации с параметром `force_sms`=`1`.

### Пример ответа

```JSON
{
  "access_token": "9d77c727986d7668986d7668049870402D1986d986d76684bbc9b1bf8488de9",
  "expires_in": 0,
  "user_id": 85635407
}
```


### Пример ответа при необходимости ввода CAPTCHA

```JSON
{
  "error": "need_captcha",
  "captcha_sid": "854844498568",
  "captcha_img": "http://api.vk.com/captcha.php?sid=854844498568&s=1"
}
```

В этом случае необходимо повторить запрос, добавив к нему следующие параметры:
* `captcha_sid` — поле `captcha_sid`, полученное в предыдущем запросе;
* `captcha_key` — то, что ввёл пользователь.

Использование API | Ключ доступа | Прямая авторизация

# VK Donut API

**API ВКонтакте** позволяет получать информацию о платных подписках и подписчиках в сообществах, использующих [VK Donut](https://vk.com/@donut-faq), а также публиковать в них платный контент.

## Для кого этот раздел

Этот раздел для разработчиков приложений, которые хотят использовать API ВКонтакте. Вам будет проще, если вы уже знакомы с [API ВКонтакте](api/getting-started), методами [авторизации](api/access-token/getting-started) и знаете, что такое [VK Donut](https://vk.com/@donut-faq).

Если вы уже используете [VK Donut](https://vk.com/@donut-faq) и разобрались, как получить [ключ доступа](api/access-token/getting-started) к API ВКонтакте, переходите к разделу [Методы](#Методы). Если нет, сначала прочитайте раздел [Подготовка](#Подготовка).

## Подготовка

1. Подключите [VK Donut](https://vk.com/@donut-faq) в настройках сообщества.

2. [Создайте приложение](api/getting-started#Регистрация%20приложения). API можно использовать в приложении любого типа. Если вы пока не знаете, какой тип выбрать, создайте **Standalone-приложение**. Идентификатор приложения понадобится вам на следующем шаге, чтобы получить ключ доступа к API.

3. Получите [ключ доступа](api/access-token/getting-started). Ключ доступа нужно будет указывать во всех запросах из приложения (параметр `access_token`). Получить его можно разными способами. Всё зависит от того, какие [права доступа](reference/access-rights) вам нужны и как вы будете отправлять запросы (от имени пользователя или сообщества, со стороны клиента или сервера).

> **Совет.** Отправлять запросы можно прямо из [документации](method/donut.isDon). Идентификатор приложения и ключ доступа указывать не понадобится, достаточно войти в свой аккаунт ВКонтакте.

## Методы

В [запросе](api/api-requests) нужно указать:

* Метод. В таблице ниже собраны методы, которые понадобятся для работы с сообществами, использующими VK Donut. Название метода может начинаться с префиксов: [`donut`](method/donut.isDon), [`groups`](method/groups.getMembers), [`wall`](method/wall.post).

* Параметры. Обязательные параметры: `access_token` (ключ доступа) и `v` (версия API). В [справочнике методов](method) написано, к какой версии API относится каждый метод, какие ещё параметры есть у метода и какие нужны [права доступа](reference/access-rights). В запросе нужно указать тот ключ доступа, права доступа которого соответствуют методу.

### Пример

Чтобы узнать, является ли пользователь доном (так мы называем получателей платного контента в сообществе), отправьте запрос:

```
https://api.vk.com/method/donut.isDon?owner_id=-1&access_token=42&v=:version
```

В этом примере замените `-1` на идентификатор сообщества (со знаком минуса), а `42` — на ключ доступа пользователя.

> **Совет.** Войдите в свой аккаунт ВКонтакте и отправьте запрос прямо из [документации](method/donut.isDon).

### Методы, которые относятся к работе VK Donut

| Метод | Результат |
| --- | --- |
| [`donut.isDon`](method/donut.isDon) | Подписан ли пользователь на платный контент (является ли доном).|
| [`donut.getSubscription`](method/donut.getSubscription) | Стоимость подписки, статус, дата следующего платежа.|
| [`donut.getSubscriptions`](method/donut.getSubscriptions) | Подписки пользователя.|
| [`donut.getFriends`](method/donut.getFriends) | Список донов из числа друзей пользователя.|
| [`groups.getMembers`](method/groups.getMembers) | Список донов сообщества по ключу пользователя (ключ должен принадлежать как минимум редактору сообщества) и по ключу сообщества (см. параметр `filter`).|
| [`wall.post`](method/wall.post) | Публикует на стене запись только для донов. Позволяет задать время, через которое запись появится для всех подписчиков, то есть станет бесплатной (см. параметр `donut_paid_duration`).|
| [`wall.edit`](method/wall.edit) | Меняет значение параметра `donut_paid_duration`.|

## События

Вы можете получать информацию о [событиях](api/events/overview), которые происходят в вашем сообществе, с помощью:

* [Callback API](api/callback/getting-started). Мы будем отправлять на ваш сервер уведомление о каждом новом событии.
* [Bots Long Poll API](api/bots-long-poll/getting-started). Очередь из событий хранится на серверах ВКонтакте, вы получаете уведомления когда захотите, используя запросы.

### События, которые относятся к работе VK Donut

|Название события | Что произошло в сообществе |
| --- | --- |
|[`donut_subscription_create`](api/community-events/json-schema#Платные%20подписки%20VK%20Donut)|Пользователь оформил подписку.|
|[`donut_subscription_prolonged`](api/community-events/json-schema#Платные%20подписки%20VK%20Donut)|Пользователь продлил подписку.|
|[`donut_subscription_expired`](api/community-events/json-schema#Платные%20подписки%20VK%20Donut)|Подписка пользователя истекла.|
|[`donut_subscription_cancelled`](api/community-events/json-schema#Платные%20подписки%20VK%20Donut)|Пользователь отменил подписку.|
|[`subscription_price_changed`](api/community-events/json-schema#Платные%20подписки%20VK%20Donut)|Изменилась стоимость подписки.|
|[`donut_money_withdraw`](api/community-events/json-schema#Платные%20подписки%20VK%20Donut)|Руководитель сообщества вывел деньги.|
|[`donut_money_withdraw_error`](api/community-events/json-schema#Платные%20подписки%20VK%20Donut)|Ошибка при выводе денег.|

## FAQ

#### Зачем нужен VK Donut?

VK Donut позволяет руководителям сообществ принимать платежи от подписчиков.

#### Где ещё можно прочитать про VK Donut?

В [сообществе](https://vk.com/donut) есть [правила публикаций](https://vk.com/@donut-pravila) и подробный FAQ, в котором мы рассказали, например, про [платежи](https://vk.com/@donut-faq?anchor=chto-vybrat-kartu-ili-vk-pay).

#### Кто такие доны?

Доны — это получатели платного контента, которые подписываются на него с помощью VK Donut.

#### Как выглядит идентификатор сообщества?

Идентификатор сообщества — это целое число (порядковый номер). Например, на странице нашего официального сообщества указан `ID:` [192668858](https://vk.com/donut). Но при работе с API используется отрицательное число -192668858, чтобы отличить идентификатор сообщества от идентификатора пользователя.

#### Почему в примере идентификатор сообщества: `-1`?

Пользователи и сообщества нумеруются по порядку, поэтому у пользователя и сообщества может быть одинаковый идентификатор. Например, есть [пользователь](https://vk.com/id1) и [сообщество](https://vk.com/apiclub) с `ID:` 1. Если метод требует передать идентификатор пользователя, нужно указывать `owner_id=1` (положительное число), если идентификатор сообщества, то `owner_id=-1` (отрицательное число).

#### В запросах можно передавать `lang`?

Да. [Параметры, общие для всего API](api/api-requests#Общие%20параметры), можно использовать во всех методах API ВКонтакте.

#### Можно ли сделать платным бесплатный контент?

Нет, если запись уже опубликована. Можно, если вы создали [отложенную запись](api/posts#Публикации%20из%20приложений) и она ещё не опубликована.

#### Можно ли сделать бесплатным платный контент?

Да. Используйте метод [`wall.post`](method/wall.post), в запросе укажите идентификатор записи (`post_id`). Обратите внимание, что в этом случае создастся бесплатная копия платной записи. Но только одна — создать больше копий не получится.

#### Я создал запись для донов, но потом решил сделать её бесплатной пораньше. Можно ли изменить время, указанное в donut_paid_duration?

Да. Чтобы изменить значение `donut_paid_duration` (время, через которое платная запись должна стать бесплатной), нужно задать новое значение этого параметра с помощью метода [`wall.edit`](method/wall.edit). Обратите внимание, что когда время истечёт, появится копия платной записи.

Интеграция | Платежи | VK Donut API

# События в реальном времени

API ВКонтакте позволяет работать с событиями пользователя или сообщества в реальном времени. Это нужно для отображения нового сообщения, для моментальной реакции на комментарий в сообществе, для создания [чат-ботов](api/bots/overview) или для анализа текстовых данных.

## Для сообществ

Для работы с событиями сообществ мы предлагаем два разных подхода:

* [Callback API](api/callback/getting-started) — в этом случае мы будем отправлять уведомление на ваш сервер о каждом новом событии.
* [Bots Long Poll API](api/bots-long-poll/getting-started) — очередь из событий хранится на стороне ВКонтакте, вы получаете их, используя Long Polling запросы.

Callback API и Bots Long Poll API поддерживают события, связанные с сообщениями сообщества, активностью пользователей на стене и в остальных разделах вашей группы или публичной страницы. Полный список событий в сообществах вы можете найти [на этой странице](api/community-events/json-schema).

## Для пользователей

[User Long Poll API](api/user-long-poll/getting-started) нужен для работы с событиями пользователя в вашем приложении. Очередь из событий хранится на стороне ВКонтакте, вы получаете их, используя Long Polling запросы.

User Long Poll API поддерживает все события, связанные с личными сообщениями (получение, редактирование, удаление), изменение статуса онлайн или счётчиков в меню.

## Для аналитики

[Streaming API](api/streaming/getting-started) позволяет получать текстовые публикации из ВКонтакте по заданным ключевым словам, не совершая лишних поисковых запросов.

Streaming API доставляет данные с помощью технологии WebSocket. Благодаря этому инструменту вы можете проанализировать частоту, тональность и контекст упоминания вашего бренда ВКонтакте, провести социологическое исследование, и многое другое.

Интеграция | Сообщества и пользователи | События пользователей и сообществ

# Быстрый старт

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

[API (application programming interface)](https://ru.wikipedia.org/wiki/API) — это посредник между разработчиком приложений и какой-либо средой, с которой это приложение должно взаимодействовать. API упрощает создание кода, поскольку предоставляет набор готовых классов, функций или структур для работы с имеющимися данными.

## Методы и объекты

**API ВКонтакте** — это интерфейс, который позволяет получать информацию из базы данных [vk.com](https://vk.com) с помощью http-запросов к специальному серверу.  Вам не нужно знать в подробностях, как устроена база, из каких таблиц и полей каких типов она состоит — достаточно того, что API-запрос об этом знает. Синтаксис запросов и тип возвращаемых ими данных строго определены на стороне самого сервиса. 

Например, для получения данных о пользователе с идентификатором `210700286` необходимо составить запрос такого вида:

```
https://api.vk.com/method/users.get?user_id=210700286&v=:version
```

Рассмотрим отдельно все его составляющие:

* `https://` — протокол соединения,
* `api.vk.com/method` — адрес API-сервиса,
* `users.get` — название метода API ВКонтакте,
* `?user_id= &v= ` — параметры запроса.

Методы представляют собой условные команды, которые соответствуют той или иной операции с базой данных — получение информации, запись или удаление. Например, `users.get` — метод для получения информации о пользователе, `video.add` — метод для добавления видеозаписи в свой список, `likes.delete` — метод для удаления отметки «Мне нравится».

Все методы разделены на секции. Например, для работы с сообществами вам нужны методы секции `groups`, для работы с фотографиями — `photos`, и так далее. Полный список методов по секциям доступен в разделе [Методы API](method).

После названия метода нужно передать его входные данные (если они есть) — как обычные GET-параметры в http-запросе. В нашем примере мы сообщаем серверу, что хотим получить данные о пользователе с `id=210700286` и формат этих данных должен соответствовать версии API  :version (о версиях мы еще поговорим позже). Входные параметры всегда перечислены на странице с описанием метода.

В ответ сервер вернет JSON-объект с запрошенными данными (или сообщение об ошибке, если что-то пошло не так). 
**JSON** — это формат записи данных в виде пар «имя свойства»: «значение». Если вы раньше не встречались с этим форматом, мы рекомендуем познакомиться с ним, прежде чем продолжить чтение: [JSON, Wikipedia](https://ru.wikipedia.org/wiki/JSON).

Ответ на наш запрос выглядит так:

```JSON
{
  "response": [
    {
      "id": 210700286,
      "first_name": "Lindsey",
      "last_name": "Stirling"
    }
  ]
}
```

Структура ответа каждого метода также строго задана, и при работе с API вы заранее знаете, что в поле `id` придет число, а в поле `first_name` — строка. Такие правила оговариваются на страницах с описанием метода и соответствующих объектов, которые он возвращает в ответе. Например, [`users.get`](method/users.get) — здесь описаны входные параметры метода и структура его ответа, а здесь — [`user`](reference/objects/user) подробно расписано каждое поле объекта из ответа.

Объект из ответа может быть не уникален для конкретного метода. Например, [объект пользователя](reference/objects/user) с набором полей, содержащих данные о его образовании, возрасте, интересах, может возвращаться в ответе от методов [`users.get`](method/users.get), [`users.search`](method/users.search), [`groups.getMembers`](method/groups.getMembers) и еще нескольких.

## Регистрация приложения

В [примере](#Методы%20и%20объекты) мы использовали метод [`users.get`](method/users.get), который позволяет получить информацию о пользователях, но для разработки приложений этого будет мало. Чтобы использовать все возможности API ВКонтакте, нужно зарегистрировать своё приложение.

Выберите [Мои приложения](https://vk.com/apps?act=manage) в верхнем меню и нажмите кнопку [Создать](https://vk.com/editapp?act=create). Создать приложение можно для одной из четырех платформ:

*  Встраиваемое приложение — вы получите приложение, которое можно встроить во фрейм с внешнего сайта. Готовые приложения можно увидеть в наших каталогах: [Мини-приложения](https://vk.com/services), [Игры](https://vk.com/apps).
*  Standalone-приложение — вы получите `API_ID` для внешнего сайта, мобильного или десктопного клиента. Основная мысль в том, что запросы к API должны отправляться с устройства пользователя. В интерфейсе такого приложения можно настроить [SDK](sdk/overview) и подключить сертификаты для push-уведомлений. 
*  Сайт — вы получите `API_ID` для внешнего сайта и работы с API через сервер. Если вы хотите написать скрипт (например, на PHP), который будет обращаться к API ВКонтакте, выберите именно этот вариант. 
*  Скилл Маруси — платформа для создания приложений, которые взаимодействуют с голосовым помощником. 

> **Совет.** Если вы пока не знаете, какую платформу выбрать, используйте Standalone-приложение. Мы обычно рекомендуем его для тренировки.

После подтверждения откроется страница с информацией о приложении. 
Откройте раздел **Настройки** в меню слева. В поле **ID приложения** будет число (например, `5490057`). Это идентификатор вашего приложения, в дальнейшем он понадобится вам, чтобы указать значение `API_ID`, `APP_ID` или `client_id`.

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

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

В API этот принцип сохраняется. Если вы скрыли список своих групп от не-друзей, то и через API ваши не-друзья не должны его увидеть. Поэтому почти все методы требуют авторизации пользователя перед началом работы. Проще говоря, сервер должен знать, кто к нему обращается за информацией, чтобы предоставить ее в том же виде, что и в основной версии сайта.

В общем случае для идентификации в API используется специальный ключ доступа, который называется `access_token`. 
**Токен** — это строка из цифр и латинских букв, которую вы передаете на сервер вместе с запросом. Из этой строки сервер получает всю нужную ему информацию. Есть разные способы получения токена, более того, он может быть выдан не только пользователю, но и сообществу, и сразу всему приложению — подробнее об этом вы можете прочитать [здесь](api/access-token/getting-started).

Мы воспользуемся самым простым способом ([Implicit flow](api/access-token/implicit-flow-user)) и получим токен для работы с API из созданного вами на прошлом этапе приложения.

Откройте новую вкладку в браузере и введите в адресную строку такой запрос:

```
https://oauth.vk.com/authorize?client_id=5490057&display=page&redirect_uri=https://oauth.vk.com/blank.html&scope=friends&response_type=token&v=:version
```

Число `5490057` в запросе нужно заменить на `API_ID` вашего приложения.

Нажмите **Enter**. Откроется окно с запросом прав. В нем отображаются название приложения, иконки прав доступа, и ваши имя с фамилией.

Нажмите **Разрешить**. вы попадете на новую страницу с предупреждением о том, что токен нельзя копировать и передавать третьим лицам. В адресной строке будет URL [`https://oauth.vk.com/blank.html`](https://oauth.vk.com/blank.html), а после `#` вы увидите дополнительные параметры — `access_token`, `expires_in` и `user_id`. Токен может выглядеть, например, так:

```
51eff86578a3bbbcb5c7043a122a69fd04dca057ac821dd7afd7c2d8e35b60172d45a26599c08034cc40a
```

Токен — это ваш ключ доступа. При выполнении определенных условий человек, получивший ваш токен, может нанести существенный ущерб вашим данным и данным других людей. Поэтому очень важно не передавать свой токен третьим лицам.

Поле `expires_in` содержит время жизни токена в секундах. 86400 секунд — это ровно сутки. Через сутки полученный токен перестанет действовать, для продолжения работы нужно будет получить новый. Есть возможность получить токен без срока действия — для этого в `scope` добавьте значение `offline`. Вы можете принудительно отозвать токен (например, в том случае, если он стал известен постороннему), сбросив сеансы в настройках безопасности вашего аккаунта или сменив пароль. Также, если речь идет о токене не из вашего собственного приложения, можно просто удалить приложение из настроек: [https://vk.com/settings?act=apps](https://vk.com/settings?act=apps)

Поле `user_id` содержит id пользователя, для которого получен токен.

Теперь вы можете сделать вызов метода от своего имени. Например, получить список друзей, которые сейчас находятся на сайте.

Для этого введите в адресную строку:

```
https://api.vk.com/method/friends.getOnline?v=:version&access_token=
```

и вставьте после знака `=` свой `access_token`, затем нажмите Enter. В ответе сервер вернет список идентификаторов ваших друзей, которые сейчас онлайн. Почитать подробнее о работе этого метода можно [здесь](method/friends.getOnline). Заметьте, вы не указали в запросе, для какого пользователя (`user_id`) нужно получить список — сервер использовал значение по умолчанию, т.е. ваш идентификатор, который он получил из токена.

Подробное руководство о получении ключей доступа находится [на этой странице](api/access-token/getting-started).

## Права доступа

Как вы уже знаете, все методы делятся на секции — `friends`, `photos`, `video` и так далее. Каждая секция соответствует определенному разделу на сайте. Часто приложения создаются для работы с конкретным разделом. Например, для просмотра фотографий или для редактирования видео. При этом логично, что приложению, которое работает только с аудиозаписями пользователя, не нужен доступ одновременно и к его личным сообщениям.

Поэтому в API права доступа приложения разграничены, как и методы. Приложение может запросить доступ только к группам, а может — к группам, фотографиям и аудиозаписям. [На этой странице](reference/access-rights) перечислены все существующие права доступа, которые можно запросить.

Чтобы запросить права, используйте параметр `scope` диалога авторизации. Когда вы получали токен для своего приложения, в `scope` было указано значение `friends` — и в окне авторизации приложение запросило доступ к друзьям.

У каждого права доступа есть уникальное название (`friends`, `video` и т.д.) и код (+2, +4, +4096). 
В `scope` можно перечислить названия нужных прав доступа (например, `scope`=`friends,video,photos`), а можно указать сумму их кодов (например, `scope`=`22`). Каждый код представляет собой степень двойки, и полученную таким образом сумму (битовую маску) вы всегда можете проверить на предмет содержания какого-то конкретного кода (например, с помощью [`account.getAppPermissions`](method/account.getAppPermissions)). 

Некоторые права доступа из соображений безопасности можно запрашивать только в Standalone-приложениях и только в процессе авторизации Implicit Flow, обратите на это внимание. 

## Что дальше

Вы познакомились с основными понятиями, связанными с API ВКонтакте. Дальше все зависит лишь от вашего вдохновения.

Конечно, на практике никто не работает с API из соседней вкладки браузера. Для этого используют самые разные языки программирования, SDK, генераторы кода. Сам механизм работы с API весьма прост, средства для отправки http-запросов и обработки ответа от сервера предусмотрены практически в любой среде разработки: а значит, возможность выбора всегда есть.

Использование API | Быстрый старт

# API для товаров

Для работы с товарами используются методы секции [`market`](method/market). В этом руководстве мы расскажем подробнее о том, что можно сделать с их помощью.

## Подготовка к работе

> [Знакомство с API](api/getting-started) — если вы ранее не имели дела с API ВКонтакте, перед началом работы мы рекомендуем узнать об основных принципах его использования.

В первую очередь подключите сервис «Товары» в настройках вашего сообщества или с помощью метода [`groups.edit`](method/groups.edit).

Вам нужно создать приложение: [https://vk.com/editapp?act=create](https://vk.com/editapp?act=create)
Для работы со стороны клиента (например, в мобильном приложении) выберите платформу **Standalone**. Для работы со стороны сервера выберите платформу **Веб-сайт**.

Укажите название и сохраните данные, подтвердив действие через СМС. вы попадете в интерфейс администрирования приложения. В дальнейшем вам понадобятся значения полей **ID приложения** (в документации — `API_ID`, `APP_ID`, `client_id`) и **Защищенный ключ** (`client_secret`, `app_secret`). 

Затем необходимо получить ключ доступа для вызова методов API. вы можете использовать один из этих подходов:

* [Implicit Flow](api/access-token/implicit-flow-user) для работы со стороны клиента.
* [Authorization Code Flow](api/access-token/authcode-flow-user) для работы со стороны сервера.
При авторизации нужно запросить у пользователя права доступа `market`. Список всех возможных прав доступа вы найдете [на этой странице](reference/access-rights).

Вызывать методы для работы с товарами вы можете [напрямую](api/api-requests) или с использованием наших [SDK](sdk/overview). 

## Действия с товарами

### Добавление товара

Используйте метод [`market.add`](method/market.add), чтобы добавить новый товар в сообщество. В `owner_id` необходимо передать идентификатор вашего сообщества со знаком минус. Название и описание задаются параметрами `name` и `description`, цена — параметром `price`. `category_id` — категория товара (например, «Аксессуары»). Список категорий можно получить методом [`market.getCategories`](market.getCategories). Если товар пока недоступен, чтобы он не отображался для пользователей, передайте `deleted = 1`.

В `main_photo_id` и `photo_ids` нужно передать идентификаторы фотографий (основной и дополнительной) для товара. вы можете узнать подробнее о загрузке фотографий [в следующем разделе](#3.%20Загрузка%20изображений).

После успешного добавления товара метод вернет его идентификатор в поле `market_item_id`. Товар можно использовать как вложение в записях на стене и личных сообщениях, для этого передайте в параметре `attachments` (`attachment`) его строковый идентификатор в виде `market-{owner_id}_{market_item_id}`, например, `market-12345_54321`.

### Действия с заказами

API помогает отслеживать новые заказы и получать о них подробную информацию.
Для этого доступны методы:

* [`market.getGroupOrders`](method/market.getGroupOrders) — возвращает заказы сообщества;
* [`market.getOrderById`](method/market.getOrderById) — возвращает заказ по идентификатору;
* [`market.getOrderItems`](method/market.getOrderItems) — возвращает товары в заказе;

Отслеживать заказы можно с помощью [событий](api/community-events/json-schema) `market_order_new` и `market_order_edit` по  [Callback API](api/callback/getting-started) или [Bots Longpoll API](api/bots-long-poll/getting-started).

Также API позволяет управлять статусами заказов. Например, обновлять их, когда заказы собраны, переданы в доставку или завершены. Для этого используется метод [`market.editOrder`](method/market.editOrder).

### Другие действия

* [`market.edit`](market.edit) — редактирование информации о товаре;
* [`market.delete`](market.delete) — удаление товара;
* [`market.addToAlbum`](market.addToAlbum) — добавление товара в одну или несколько подборок;
* [`market.get`](market.get) — получение списка товаров из сообщества;
* [`market.getById`](market.getById) — получение товара по его идентификатору;
* [`market.search`](market.search) — поиск товаров в сообществе;
* [`market.getComments`](market.getComments) — получение списка комментариев к товару;
* [`market.createComment`](market.createComment) — добавление комментария к товару;
* [`market.deleteComment`](market.deleteComment) — удаление комментария к товару;
* [`market.reorderItems`](market.reorderItems) — сортировка товаров в подборке;
* [`market.getAlbums`](market.getAlbums) — получение списка подборок из сообщества;
* [`market.getAlbumById`](market.getAlbumById) — получение подборки по ее идентификатору;
* [`market.editAlbum`](market.editAlbum) — редактирование подборки товаров;
* [`market.addAlbum`](market.addAlbum) — добавление подборки товаров.

## Загрузка изображений

### Загрузка основного изображения для товара

Допустимые форматы: JPG, PNG, GIF.
Ограничения: минимальный размер фото — 400x400px, сумма высоты и ширины не более 14000px, файл объемом не более 50 МБ.
Поле `POST`-запроса: `file`.

#### Получение адреса

Вызовите метод  с параметром `main_photo` = `1`, чтобы получить адрес для загрузки фото. 

#### Передача файла

Передайте файл на адрес `upload_url`, полученный в предыдущем пункте, сформировав `POST`-запрос с полем `file`. Это поле должно содержать изображение в формате `multipart/form-data`.

После успешной загрузки сервер возвращает в ответе JSON-объект с полями `server`, `photo`, `hash`, `crop_data`, `crop_hash`:

```json
{
"server":625831,
"photo":"[{\"photo\":\"8d81799f90:w\",\"sizes\":[[\"s\",\"625831075\",\"45839\",\"-5fbUeQq1YY\",75,56],[\"m\",\"625831075\",\"4583a\",\"G8yAYbsk7M4\",130,97]]}]",
"hash":"8954a4da5ba06d4e",
"crop_data":"oAAmMpwAAAAAlTWyjA",
"crop_hash":"729155760247b391134"
}
```

Поле `server`  содержит числовое значение, в `hash`, `crop_data` и `crop_hash` возвращаются строки, а в поле `photo` находится JSON-объект, структуру которого важно сохранить в исходном виде (убрав, однако, экранирование символов перед дальнейшим использованием). В PHP вы можете использовать `json_decode()` для всего ответа и затем `stripslashes()` для объекта `photo`.

#### Сохранение результата

Чтобы сохранить фотографию, вызовите метод  с параметрами `server`, `photo`, `crop_data`, `crop_hash`, полученными на предыдущем этапе.

После успешной загрузки фотографии вы можете прикрепить ее к товару, используя методы [`market.add`](method/market.add) или [`market.edit`](method/market.edit) и указав идентификатор фотографии в параметре `main_photo_id`.

### Загрузка дополнительных изображений

Допустимые форматы: JPG, PNG, GIF.
Ограничения: минимальный размер фото — 400x400px, сумма высоты и ширины не более 14000px, файл объемом не более 50 МБ.
Поле `POST`-запроса: `file`.

#### Получение адреса

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

#### Передача файла

Передайте файл на адрес `upload_url`, полученный в предыдущем пункте, сформировав `POST`-запрос с полем `file`. Это поле должно содержать изображение в формате `multipart/form-data`.

После успешной загрузки сервер возвращает в ответе JSON-объект с полями `server`, `photo`, `hash`:

```json
{
"server":625831,
"photo":"[{\"photo\":\"8d81799f90:w\",\"sizes\":[[\"s\",\"625831075\",\"45839\",\"-5fbUeQq1YY\",75,56],[\"m\",\"625831075\",\"4583a\",\"G8yAYbsk7M4\",130,97]]}]",
"hash":"8954a4da5ba06d4e",
}
```

Поле `server`  содержит числовое значение, в `hash`, а в поле `photo` находится JSON-объект, структуру которого важно сохранить в исходном виде (убрав, однако, экранирование символов перед дальнейшим использованием). В PHP вы можете использовать `json_decode()` для всего ответа и затем `stripslashes()` для объекта `photo`.

#### Сохранение результата

Чтобы сохранить фотографию, вызовите метод  с параметрами `server` и `photo`, полученными на предыдущем этапе.

После успешной загрузки фотографии вы можете прикрепить ее к товару, используя методы [`market.add`](method/market.add) или [`market.edit`](method/market.edit) и указав идентификатор фотографии в параметре `photo_ids`.

### Загрузка фотографии для подборки товаров

Допустимые форматы: JPG, PNG, GIF.
Ограничения: минимальный размер фото — 1280x720px, сумма высоты и ширины не более 14000px, файл объемом не более 50 МБ.
Название поля POST-запроса: `file`.

#### Получение адреса

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

#### Передача файла

Передайте файл на адрес `upload_url`, полученный в предыдущем пункте, сформировав `POST`-запрос с полем `file`. Это поле должно содержать изображение в формате `multipart/form-data`.

После успешной загрузки сервер возвращает в ответе JSON-объект с полями `server`, `photo`, `gid`, `hash`

```json
{
"server":999,
"photo":"eyJwaG90byI6IntcInBob",
"gid":102416739,
"hash":"0adc3bd6509fdcf97052b0594c4063ff"
}
```

Поля `server` и `gid` содержат числовые значения, а в полях `photo` и `hash` возвращаются строки.

### Сохранение результата

Чтобы сохранить фотографию, вызовите метод  с параметрами `server`, `photo`, `hash`, полученными на предыдущем этапе.

После успешной загрузки фотографии вы можете прикрепить ее к подборке товаров, используя методы [`market.addAlbum`](method/market.addAlbum) или [`market.editAlbum`](method/market.editAlbum) и указав идентификатор фотографии в параметре `photo_id`.

## Готовые инструменты

Популярные платформы интернет-магазинов предлагают готовые решения для интеграции с сервисом товаров ВКонтакте:

### Конструкторы интернет магазинов  

*  [InSales](https://www.insales.ru/collection/integratsiya-s-vkontakte/product/nastroyka-vygruzki-tovarov-iz-insales-vo-vkontkakte)
*  [AdvantShop](https://www.advantshop.net/help/pages/module-vkmarket)
*  [Эквид](https://www.ecwid.ru/blog/ecwid-with-vkmarket.html)
*  [Tilda](https://help-ru.tilda.cc/online-store-payments/vk)
*  [Setup.ru](https://www.setup.ru/instructions/vk)
*  [OpenCart](https://github.com/crmagent-developers/opencart-vk-module)
*  [WordPress](https://github.com/crmagent-developers/woocommerce-vk-module)
*  [Woocommerce](https://wordpress.org/plugins/vkmarket-for-woocommerce/)

### CRM системы  

* [RetailCRM](https://vk.cc/bVtnwH)
* [1C:CRM](https://1crm.ru/help/integratsiya-s-magazinom-vkontakte/)
* [Бизнес.Ру](https://vk.com/@ecom-integraciya-magazina-vkontakte-i-biznesru)

### Программы складского учёта  

*  [МойСклад](https://support.moysklad.ru/hc/ru/articles/226865387)

### Прочее  

*  October CMS — плагин [Shopaholic for VK Goods](https://octobercms.com/plugin/lovata-vkgoodsshopaholic)
*  [Workzen](https://workzen.mts.ru/help/vk)
*  [ZoomKit](https://vkm.zoomkit.ru) — загрузка товаров в vk.com через фиды данных Яндекс.Маркета, Яндекс.Недвижимости и Auto.ru
*  [Cloudparser](https://cloudparser.ru) — выгрузка товаров с сайтов поставщиков
* [iBurattino](http://iburattino.com), [VK-Sync](http://vk-sync.ru), [Soc-commerce](http://soc-commerce.com), [vkExport](https://vkexport.net/) — YML
*  [1С-Битрикс](https://marketplace.1c-bitrix.ru/solutions/vkapi.vkmarket/), [https://marketplace.1c-bitrix.ru/solutions/bxmaker.vk/](https://marketplace.1c-bitrix.ru/solutions/bxmaker.vk/)
*  [Электронный Заказ](https://ez-catalog.ru/) — электронный заказ, импорт товаров из XML, YML, CSV
*  [Trimpo](https://trimpo.org/) — импорт из YML, Excel, ручное добавление товаров
*  CMS ShopScript — [vkgoods](https://www.webasyst.ru/store/plugin/shop/vkgoods/)
*  [Sliza](https://sliza.ru/pages/instruction)
*  [Выгрузка товаров ВКонтакте и Одноклассники](https://my-market-app.ru/)

API ВКонтакте | Товары | API для товаров

# Товары ВКонтакте

**Товары ВКонтакте** – это витрина с товарами и услугами в вашем сообществе ВКонтакте. 

![title=Блок с товарами на главной странице сообщества](11022d528d5d387fbb61f51e4b046d5e0d78379a23f968b0861afd1d "-5203208861033356884")

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

## Как это работает?

Вы добавляете в сообщество товары с фотографиями, ценами и подробным описанием. Используйте подборки (коллекции товаров по категориям), чтобы клиенты могли быстро разобраться в ассортименте. 

![title=В разделе с товарами доступен поиск по наименованию и цене](2cc1ea6be1122788c3e90128a73878337ddd05d50a8fcb2ec055c406 "2682289002888373244")

Для каждого товара можно загрузить до четырех дополнительных изображений. Наглядные фотографии с разных ракурсов помогут пользователю сделать выбор. 

![title=Карточка товара – сюда можно добавить любую информацию, полезную для покупателя](b386c4e88a09935cb2b07d43dfdcc36b04ad0e3353da8b99f177dbf1 "-637134464653778470")

Кнопка **Написать продавцу** в карточке товара откроет переписку с сообществом или выбранным руководителем сообщества. К сообщению будет прикреплена ссылка на товар, который заинтересовал пользователя. 

В настройках сервиса (раздел **Управление сообществом** → **Товары**) вы можете задать валюту магазина, регионы доставки, контактное лицо. Заполните вики-страницу **Описание магазина** – здесь пользователи смогут прочитать об условиях оплаты и доставки перед покупкой. 

Выбор способа оплаты и доставки заказов остается за вами. 

## Доставка

Теперь доставлять товары через Boxberry и СДЭК можно прямо из Магазина ВКонтакте. Это удобное решение для бизнеса и клиентов, которое поможет продавать быстрее и больше. 

![](d84302030ec7bf82e0824216cd40405b0f35762c05c8fbd7f123eeb8 "-536902625946196038")

### Подключите доставку

Вначале убедитесь, что у вас включён Магазин 2.0 в настройках сообщества. 

Нажмите **Управление** → **Настройки** → **Разделы**. Включите раздел **Товары**. Для работы с доставкой должен быть выбран **Расширенный** режим. 

![](d2b5b34c5da9100bff19aec8d49be18a7d99ded64798fe42c557a02e "8014173844027144298")

Нажмите **Показать настройки** → **Доставка**. Также перейти в настройки магазина можно через главную страницу сообщества. 

![](7a6b0cd237030915c8546f4023ef9e4f75796655401306a5c23a113c "7767136780412586436")

Нажмите **Включить** для Boxberry и СДЭК. 

![](39a7f82a6cf220740f1e7d3b86b4a387e7bc86579d064c6207bc7827 "-4074010642457854577")

Для СДЭК и Boxberry стоимость доставки рассчитывается по габаритам и весу товара. Указать эти параметры вы можете заранее в карточке товара – тогда прогноз для покупателя будет точным. Вес и габариты также можно прописать на этапе получения заказа. 

## Укажите свойства товаров

Помимо веса и габаритов товара вы можете указать его дополнительные свойства: цвет, материал, размер и другие. 

![](75cafdffa3a261a3af5ebdb6788b3c3a0e9c6f0168e611b45a0802c2 "-4967459588447635267")

## Проверьте поступивший заказ

Внимательно проверьте все данные. При необходимости вы можете отредактировать здесь вес и габариты заказа, если не указали их ранее, —стоимость доставки рассчитается автоматически. 

Из этого же окна вы можете связаться с покупателем и уточнить детали заказа. 

![](7dd640fdd996ee64368dd36520497c5f916cda6c226e47d2a1e03d9d "-6931970821843698708")

Включите сообщения сообщества, чтобы отвечать покупателям. Написать от лица сообщества можно сразу после того, как поступил заказ. 

## Договоритесь об оплате

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

>  **Важно.** Доставку оплачивает покупатель. Она уже будет включена в стоимость заказа, если вы указали габариты и вес товара. Если вы не вносили эти данные, то клиент увидит сообщение **Стоимость уточняйте у продавца**. 

Отправка через СДЭК рассчитывается по тарифу **Экспресс-лайт**, подробности описаны по [ссылке](https://cdek.ru/express-light). Стоимость доставки Boxberry рассчитывается по специальному тарифу для магазинов ВКонтакте. 

## Отправьте заказ

Получив заказ, в котором указан способ доставки через СДЭК или Boxberry, нужно убедиться, что рассчитана стоимость. 

Если вы заранее прописали габариты товара – заказ поступит к вам уже с фиксированной стоимостью доставки. 

Если ещё не сделали этого – перейдите в карточку заказа и укажите габариты и вес в специальном поле, и мы автоматически всё подсчитаем. 

Что делать дальше:

*  Принять у покупателя оплату удобным ему способом. 
*  Отвезти заказ в ближайшее отделение выбранной службы или вызвать курьера, который заберёт от вас посылку. 
*  Сервис доставки закрепит за вашим отправлением трек-номер и сразу сообщит его вам. 

Найти ближайшее отделение можно здесь: [Boxberry](https://boxberry.ru/find_an_office/) и [СДЭК](https://cdek.ru/offices). Обе компании работают с физическими и юридическими лицами. 

## Добавьте трек-номер

Впишите трек-номер в соответствующее поле. Так пользователю будет проще отслеживать посылку на сайте доставки – будет достаточно одного клика из раздела **Заказы**. 

![](a5b0a5d31fbae44ec0aedc30e75625128639282b0279dc8529c5ffd8 "1565333712537667774")

> **Важно.** Не забудьте при отправке сменить статус заказа на **Доставляется**: тогда пользователь сразу получит уведомление о том, что товар в пути. 

![](55f4339a699abb4df078b1f3293c5fc25900ecae0c844aac4b617bd0 "5578399229701508714")

## API для товаров

API позволяет автоматизировать работу с товарами и заказами. Используйте готовое решение для импорта товаров из внешней базы или создайте собственный инструмент – это просто. 

> Подробнее о методах API ВКонтакте для работы с товарами в сообществах мы рассказали в разделе [API для товаров](api/market/getting-started).

## Готовые инструменты

Используйте готовые решения, созданные нашими партнерами, для быстрого импорта товаров из вашего магазина в сообщество ВКонтакте:

###  Конструкторы интернет магазинов

*  InSales – [https://www.insales.ru/collection/integratsiya-s-vkontakte/product/nastroyka-vygruzki-tovarov-iz-insales-vo-vkontkakte](https://www.insales.ru/collection/integratsiya-s-vkontakte/product/nastroyka-vygruzki-tovarov-iz-insales-vo-vkontkakte)
*  AdvantShop – [https://www.advantshop.net/help/pages/module-vkmarket](https://www.advantshop.net/help/pages/module-vkmarket)
*  Эквид – [https://www.ecwid.ru/blog/ecwid-with-vkmarket.html](https://www.ecwid.ru/blog/ecwid-with-vkmarket.html)
*  Tilda – [https://help-ru.tilda.cc/online-store-payments/vk](https://help-ru.tilda.cc/online-store-payments/vk)
*  Setup.ru – [https://www.setup.ru/instructions/vk](https://www.setup.ru/instructions/vk)
*  OpenCart – [https://github.com/crmagent-developers/opencart-vk-module](https://github.com/crmagent-developers/opencart-vk-module)
*  WordPress – [https://github.com/crmagent-developers/woocommerce-vk-module](https://github.com/crmagent-developers/woocommerce-vk-module)
*  Nethouse – [https://vk.nethouse.ru/](https://vk.nethouse.ru/)

###  CRM системы

*  RetailCRM – [https://vk.cc/bVtnwH](https://vk.cc/bVtnwH)
*  1C-CRM – [https://1crm.ru/help/integratsiya-s-magazinom-vkontakte/](https://1crm.ru/help/integratsiya-s-magazinom-vkontakte/)
*  amoCRM – [https://cmdf5.ru/widjety-amocrm/vk-amocrm](https://cmdf5.ru/widjety-amocrm/vk-amocrm)
*  Битрикс 24 – [https://www.bitrix24.ru/apps/?app=integrations24.vkmarket](https://www.bitrix24.ru/apps/?app=integrations24.vkmarket&_ga=2.210223517.984684472.1635850697-325262892.1635850697&)
*  1С-Битрикс – [https://marketplace.1c-bitrix.ru/solutions/vkapi.market](https://marketplace.1c-bitrix.ru/solutions/vkapi.market)

###  Программы складского учёта

*  МойСклад – [https://support.moysklad.ru/hc/ru/articles/226865387](https://support.moysklad.ru/hc/ru/articles/226865387)
*  Бизнес.Ру – [https://vk.com/@ecom-integraciya-magazina-vkontakte-i-biznesru](https://vk.com/@ecom-integraciya-magazina-vkontakte-i-biznesru)

###  Прочее

*  October CMS – плагин [Shopaholic for VK Goods](https://octobercms.com/plugin/lovata-vkgoodsshopaholic)
*  Workzen – [https://workzen.mts.ru/help/vk](https://workzen.mts.ru/help/vk)
*  Загрузка товаров в vk.com через фиды данных Яндекс.Маркета, Яндекс.Недвижимости и Auto.ru – [ZoomKit](https://vkm.zoomkit.ru)
*  Выгрузка товаров с сайтов поставщиков – [Cloudparser](https://cloudparser.ru)
*  Soc-commerce – [https://soc-commerce.com/](https://soc-commerce.com/)
*  Albato – [https://albato.ru/app-vkmarket](https://albato.ru/app-vkmarket)
* [iBurattino](http://iburattino.com), [VK-Sync](http://vk-sync.ru), [Soc-commerce](http://soc-commerce.com), [vkExport](https://vkexport.net/) — YML
*  [1С-Битрикс](https://marketplace.1c-bitrix.ru/solutions/vkapi.vkmarket/), [https://marketplace.1c-bitrix.ru/solutions/bxmaker.vk/](https://marketplace.1c-bitrix.ru/solutions/bxmaker.vk/)
*  [Электронный Заказ](https://ez-catalog.ru/) — электронный заказ, импорт товаров из XML, YML, CSV
*  [Trimpo](https://trimpo.org/) — импорт из YML, Excel, ручное добавление товаров
*  CMS ShopScript — [vkgoods](https://www.webasyst.ru/store/plugin/shop/vkgoods/)
*  [Sliza](https://sliza.ru/pages/instruction)
*  [Выгрузка товаров ВКонтакте и Одноклассники](https://my-market-app.ru/)

API ВКонтакте | Товары | Товары ВКонтакте

# Диалог авторизации OAuth

Для того, чтобы авторизовать пользователя, необходимо перенаправить его браузер по адресу [`https://oauth.vk.com/authorize`](https://oauth.vk.com/authorize), передав следующие параметры:

* `client_id` (**обязательный параметр**) — Идентификатор вашего приложения.  
* `redirect_uri` (**обязательный параметр**) — Адрес, на который будет переадресован пользователь после прохождения авторизации (домен указанного адреса должен соответствовать основному домену в настройках приложения).
* `display` (**обязательный параметр**) — Указывает тип отображения страницы авторизации. Поддерживаются следующие варианты:
    *  `page` — форма авторизации в отдельном окне;
    *  `popup` — всплывающее окно;
    *  `mobile` — авторизация для мобильных устройств (без использования Javascript).
    Если пользователь авторизуется с мобильного устройства, будет использован тип  `mobile`.  
* `scope` — Битовая маска [настроек доступа приложения](reference/access-rights), которые необходимо проверить при авторизации пользователя и запросить, в случае отсутствия необходимых.  
* `response_type` —Тип ответа, который вы хотите получить:
    *  `code` —  если вы хотите делать запросы со стороннего сервера (по умолчанию);
    *  `token` — если вы хотите делать запросы с клиента.

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

```
https://oauth.vk.com/authorize?client_id=1&redirect_uri=http://example.com/callback&scope=12&display=mobile
```
> **Примечание.** Если вы разрабатываете Standalone-приложение в параметре `response_type` передаете `token`, то в качестве параметра  `redirect_uri` необходимо указывать адрес [https://oauth.vk.com/blank.html](https://oauth.vk.com/blank.html), на который будут переданы данные авторизации. Обратите внимание, что только в данном случае у вас будет возможность использовать расширенные методы работы с API.

Использование API | Диалог авторизации OAuth

Интеграция | Сообщества и пользователи | Open API

# Быстрый старт

**Платёжный API** — это API для работы с платёжной системой в играх и мини-приложениях. Он нужен, чтобы продавать в приложении виртуальные товары или услуги. 

Пользователь оплачивает покупки внутренней валютой ВКонтакте (голосами), но для удобства стоимость товара отображается в рублях.

![title=Диалоговое окно платежа в приложении.](6bdd0b4f3e1eb1e9b339105672c7472128d9b3aa284d76f8c3c9799b "-708128452752560712")

В этом руководстве мы расскажем, как подключить платёжную систему в вашем приложении ВКонтакте.

## Платежи ВКонтакте

> Для платежей за товары и услуги используйте [VK Pay](pay/getting-started).

Подойдёт для платежей в чат-ботах, сообществах ВКонтакте, сервисах VK Mini Apps и на сторонних сайтах. Оплата происходит с баланса VK Pay или привязанных к нему банковских карт.

> Для платежей в играх и мини-приложениях используйте голоса.

Голоса — универсальная платёжная единица ВКонтакте, которая используется для оплаты виртуальных товаров. Пользователи могут пополнить свой виртуальный счёт голосами с помощью банковских карт, электронных кошельков, СМС и другими способами. 

Пользователь оплачивает покупки в игре или мини-приложении внутренней валютой ВКонтакте (голосами) следующим образом:
1. Пользователь выбирает виртуальный товар в приложении.
2. С его личного баланса списывается число голосов, равное стоимости покупки.
3. Счёт приложения пополняется на стоимость покупки.

## Подготовка серверной части 

В первую очередь нужно реализовать на вашем сервере скрипт для [обработки уведомлений от платёжной системы ВКонтакте](api/payments/notifications/overview). Такое уведомление представляет собой `POST`-запрос с заданной структурой данных. Ваш сервер должен уметь своевременно отправлять ответ с запрошенной информацией. Например, это могут быть данные о товаре, который хочет купить пользователь в вашем приложении.

## Настройки платежей в приложении 

Откройте страницу редактирования вашего приложения и перейдите на вкладку **Платежи**. Здесь нужно указать адрес обратного вызова (URL на вашем сервере, где размещён скрипт обработки уведомлений). Чтобы проводить оплату в [тестовом режиме](#Тестовый%20режим), в поле **Тестировщики платежей** выберите пользователей, которые будут тестировать платёжную систему.

Пока приложение не прошло модерацию, в нём доступны только тестовые платежи.

## Вызов диалогового окна 

Пользователь выбирает виртуальный товар или подписку в приложении, после этого открывается диалоговое окно ВКонтакте с описанием и стоимостью. Можно подтвердить покупку или отменить её. Если на балансе недостаточно голосов, будет предложено пополнить его одним из доступных способов.

![title=Диалоговое окно платежа в приложении;](d1be181ea82a0a515a5476d52cb862a79143548e587b81e2a0db94cb "-2162674972032947764")

Чтобы показать диалоговое окно, используйте метод [`showOrderBox`](sdk/javascript#showOrderBox) или [`showSubscriptionBox`](sdk/javascript#showSubscriptionBox) из Client API. 

Типовой JS-код для открытия окна:

```JavaScript
function order() {
    const params = {
        type: 'item',
        item: 'item_25new'
    };

   VK.callMethod('showOrderBox', params);
}
```

После успешной оплаты товара приложению будет отправлено событие `onOrderSuccess` с идентификатором заказа. 

**Внимание!** Это событие нельзя использовать для принятия решения о предоставлении пользователю виртуального товара. Проверяйте специальное уведомление [`order_status_change`](api/payments/notifications/order-status-change), которое отправляется на ваш сервер.

### Диалоговое окно платежа

Этот диалог показывается пользователю после выбора виртуального товара на странице приложения.

![title=Диалоговое окно платежа в приложении.](d1be181ea82a0a515a5476d52cb862a79143548e587b81e2a0db94cb "-2162674972032947764")

#### Параметры `showOrderBox`

Чтобы показать диалоговое окно платежа, используйте метод [`showOrderBox`](sdk/javascript#showOrderBox) из Client API. Он принимает следующие параметры:

### `type` 

`string`

 Тип заказа. Возможные значения: 
  `votes` — окно для ввода голосов на счёт приложения; 
  `offers` — окно со списком специальных предложений (офферов), которые могут быть использованы пользователем для получения голосов; 
  `item` — покупка товара. 

### `votes` 

`integer`

Количество голосов для ввода на счёт приложения (для `type = votes`). 

### `offer_id` 

`integer`

Идентификатор рекламной акции (для `type = offers`). 

### `currency` 

`integer`, [`0`,`1`]

`1` — стоимость специальных предложений будет отображена в [валюте приложения](#Платежи%20в%20валюте%20приложения) (для `type = offers`). 

### `item` 

`string`

Наименование товара, которое будет отправлено в уведомлении `get_item` (для `type = item`). Строка длиной до 64 символов. Например, `item_25new`.   

#### События

После завершения оплаты в зависимости от результата в обработчик отправляется одно из трёх событий:

 | Название | Параметры | Описание |
|---|---|---|
 | `onOrderCancel` | — | Пользователь отменил покупку. |
 | `onOrderSuccess` | `orderId` (`integer`) | Покупка закончилась успешно. 
 `orderId` — идентификатор заказа. Подробную информацию об обработке платежных уведомлений вы можете найти на [этой странице](api/payments/notifications/overview). |
 | `onOrderFail` | `errorCode`  (`integer`)| Покупка закончилась неуспешно. 
 `errorCode` — код ошибки. Подробную информацию об ошибках платежных уведомлений вы можете найти на [этой странице](api/payments/notifications/overview#Формат%20ответа%20в%20случае%20ошибки). |

#### Пример кода на JavaScript 

```JavaScript
<script type="text/javascript">

// Функция order() отображает окно для покупки товара с наименованием "item_25new". 
// Названия платёжных событий пишутся в контейнер с id="callbacks".

  function order() {
    var params = {
      type: 'item',
      item: 'item_25new'
    };
    VK.callMethod('showOrderBox', params);
  }

  var callbacksResults = document.getElementById('callbacks');

  VK.addCallback('onOrderSuccess', function(order_id) {
    callbacksResults.innerHTML += '<br />onOrderSuccess '+order_id;
  });
  VK.addCallback('onOrderFail', function() {
    callbacksResults.innerHTML += '<br />onOrderFail';
  });
  VK.addCallback('onOrderCancel', function() {
    callbacksResults.innerHTML += '<br />onOrderCancel';
  });
</script>
```

### Диалоговое окно подписки

#### Параметры `showSubscriptionBox`

Чтобы показать диалоговое окно подписки, нужно вызвать метод [`showSubscriptionBox`](sdk/javascript#showSubscriptionBox) из Client API. Вторым аргументом передайте `action` — действие, которое необходимо совершить. Возможные значения:
* `create` — приобрести подписку;
* `resume` — возобновить подписку;
* `cancel` — отменить подписку.

Метод `showSubscriptionBox` принимает следующие параметры:

### `item` 

`string`

Наименование подписки, которое будет отправлено в уведомлении [`get_subscription`](api/payments/notifications/get-subscription). Строка длиной до 64 символов. Например: `subscription_25new` (для `action = create`). 

### `subscription_id` 

`integer`

Идентификатор подписки (для `action = resume, cancel`). 

#### События

После завершения оплаты в зависимости от результата в обработчик отправляется одно из трёх событий:

 | Название | Параметры | Описание |
|---|---|---|
 | `onSubscriptionCancel` | — | Пользователь отменил покупку. |
 | `onSubscriptionSuccess` | `subscription_id` (`integer`) | Покупка закончилась успешно. 
`subscription_id` — идентификатор подписки. Подробную информацию об обработке платежных уведомлений вы можете найти на [этой странице](api/payments/notifications/overview). |
 | `onSubscriptionFail` | `errorCode` (`integer`)| Покупка закончилась неуспешно. 
 `errorCode` — код ошибки. Подробную информацию об ошибках платежных уведомлений вы можете найти на [этой странице](api/payments/notifications/overview#Формат%20ответа%20в%20случае%20ошибки). |

> Обратите внимание — в тестовом режиме подписка 5 раз автоматически продлевается раз в 10 минут (для `period = month`) и раз в 2 минуты для других значений `period`. После этого подписка автоматически отменяется.

#### Пример кода на JavaScript

```JavaScript
<script type="text/javascript">
  function order() {
    VK.callMethod('showSubscriptionBox', 'create', {item: 'subscription1'});
  }

  var callbacksResults = document.getElementById('callbacks');

  VK.addCallback('onSubscriptionSuccess', function(subscription_id) {
    callbacksResults.innerHTML += '<br />onSubscriptionSuccess '+subscription_id;
  });
  VK.addCallback('onSubscriptionFail', function() {
    callbacksResults.innerHTML += '<br />onSubscriptionFail';
  });
  VK.addCallback('onSubscriptionCancel', function() {
    callbacksResults.innerHTML += '<br />onSubscriptionCancel';
  });
</script>
```

Функция `order` позволяет отобразить пользователю окно для покупки товара с наименованием `'subscription_25new'`. Названия произошедших платёжных событий пишутся в контейнер с `id="callbacks"`.

## Тестовый режим

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

Тестовый режим необходимо использовать пока ваше приложение не прошло проверку администрацией ВКонтакте. Платежи осуществляются в «боевом» режиме сразу после прохождения процедуры проверки приложения.

Для осуществления платежей в тестовом режиме необходимо добавить всех пользователей, совершающих тестовые платежи, в специальный список в настройках приложения (поле **Тестировщики платежей**).

![](33327db1023a46d0548612a270d8330ee0e7e4678ca689697daefe49 "4424661819184374092")

В тестовом режиме к параметру `notification_type` добавляется суффикс `'_test'`. Таким образом, уведомления будут называться `'get_item_test'`, `'order_status_change_test'`, `'get_subscription_test'`, `'subscription_status_change '` соответственно (см. [Платёжные уведомления](api/payments/notifications/overview)).

При этом идентификаторы заказов в тестовом режиме – параметры `order_id` у уведомлений – могут пересекаться с идентификаторами заказов в рабочем режиме.

Обратите внимание — в тестовом режиме подписка 5 раз автоматически продлевается раз в 10 минут (для `period = month`) и раз в 2 минуты для других значений `period`. После этого подписка автоматически отменяется. Уведомления приходят только при изменении статуса подписки, в случае продления уведомления не приходят. Подробнее см. [Изменение статуса подписки](api/payments/notifications/subscription-status-change).

## Модерация приложения 

Если ваше приложение ещё не отправлялось на проверку и не размещено в общем каталоге, самое время сделать это. Иначе пользователи не смогут оплатить что-либо в нём.
После проверки вы можете убрать себя из списка тестировщиков платежей в настройках приложения, чтобы начать осуществлять платежи в боевом режиме.

Чтобы приложение успешно прошло модерацию, убедитесь, что оно соответствует Правилам.

## Методы `orders` 

Метод API [`orders.get`](method/orders.get) позволяет получить список заказов с их текущими статусами. 
Чтобы отменить заказ, используйте метод [`orders.changeState`](method/orders.changeState), передав идентификатор заказа и новый статус заказа `refund`. Голоса вернутся на баланс пользователя. На балансе приложения должно быть достаточно голосов для возврата. Весь список методов секции `orders` можно посмотреть [здесь](method/orders).

Интеграция | Платежи | Платёжный API | Быстрый старт

# Получение информации о подписке

Это уведомление отправляется при открытии [диалогового окна подписки](api/payments/getting-started#Диалоговое%20окно%20подписки) через приложение. 

## Параметры уведомления

| Название параметра | Примечение |
 |---|---|
 | `app_id` `integer` | Идентификатор приложения. |
 | `item` `string` | Наименование товара, переданное [диалоговому окну подписки](api/payments/getting-started#Диалоговое%20окно%20подписки). |
 | `lang` `string` | Язык пользователя в формате `язык_страна`. Сейчас поддерживается 4 языка: `ru_RU` — русский, `uk_UA` — украинский, `be_BY` — белорусский, `en_US` — английский. |
 | `notification_type` `string` | Тип уведомления. Равен `get_subscription` или `get_subscription_test`. |
 | `order_id` `integer` | Идентификатор заказа в системе платежей ВКонтакте. |
 | `receiver_id` `integer` | Идентификатор получателя заказа (совпадает с `user_id`, но в будущем может отличаться). |
 | `user_id` `integer` | Идентификатор пользователя, создавшего заказ. |
 | `sig` `string` | Подпись уведомления (см. [Проверка подписи](api/payments/notifications/overview#Проверка%20подписи)). |

## Параметры ответа

По полученному в уведомлении наименованию товара `item` разработчик должен вернуть актуальную информацию о нём. При отсутствии товара необходимо выдать в ответе ошибку 20, «Подписки не существует». 

> **Внимание!** Так как `item` передаётся на клиентской стороне, этот параметр может быть изменён пользователем. 

| Название параметра | Примечение |
 |---|---|
 | `item_id` `integer` | Идентификатор товара в приложении. |
 |`title` `string`, обязательный | Название подписки. |
 | `description` `string` | Описание подписки.  |
 | `photo_url` `string` | URL изображения для подписки на сервере разработчика.  |
 | `price` `integer` | Стоимость подписки в голосах. |
 | `period` `integer` | Период действия подписки. Возможные значения: `7` — 7 дней, `30` — 30 дней, `90` — 90 дней. |
 |`trial_duration` `integer` | Длительность триал-периода. Возможные значения: `3` — 3 дня, `7` — 7 дней, `30` — 30 дней. |
 |`expiration` `integer` | Разрешает кэширование товара на `{expiration}` секунд. Допустимый диапазон от 600 до 604800 секунд. **Важно!** При отсутствии параметра возможно кэширование товара на 3600 секунд при большом количестве подряд одинаковых ответов. Для отмены кэширования необходимо передать `0` в качестве значения параметра. |

Если `expiration = 0` или не определён, то для подписки с одним идентификатором `item` допускается возвращать различные названия, изображения и цены. 

> **Внимание!** Рекомендуется всегда использовать кэширование, чтобы пользователи не ожидали получения информации, и чтобы уменьшить количество обращений к серверу приложения. 

## Пример ответа

```JSON
{
    "response": {
        "item_id":50,
        "title":"VIP Status",
        "photo_url":"http:\/\/vk.com\/images\/gift\/90\/96.jpg",
        "price":1,
        "period":7,
        "trial_duration":7,
        "expiration":600
    }
}

```

Интеграция | Платежи | Платёжный API | Получение информации о подписке

# Изменение статуса заказа

Присылается в момент изменения статуса заказа. 

> **Важно!** В случае получения повторного уведомления типа **Изменения статуса заказа** (с тем же `order_id`) ответ должен в точности повторять ответ для исходного уведомления. 

Например, если было отправлено это уведомление, и был получен положительный ответ, но он не дошел до сервера ВКонтакте, или по каким-то временным причинам не удалось перевести заблокированные средства на счет приложения сразу после получения ответа, такое же уведомление будет отправлено повторно. При этом не нужно выполнять новый заказ, достаточно просто прислать тот же ответ, что и в предыдущий раз (сохранив у себя `order_id` и проверив по нему, что такое уведомление уже приходило). 

## Параметры уведомления

 | Название параметра | Примечение |
 | --- | --- |
 | `notification_type` `string` |  Тип уведомления. Равен `order_status_change` или `order_status_change_test`. |
 | `app_id` `integer` | Идентификатор приложения. |
 | `user_id` `integer` | Идентификатор пользователя, сделавшего заказ |
 | `receiver_id` `integer` | Идентификатор получателя заказа (в данный момент совпадает с `user_id`, но в будущем может отличаться). |
 | `order_id` `integer` | Идентификатор заказа в системе платежей ВКонтакте |
 | `date` `integer` | Дата создания заказа (в формате `Unixtime`). |
 | `status` `string` | Новый статус заказа. Возможные значения: `chargeable` — заказ готов к оплате. Необходимо оформить заказ пользователю внутри приложения. В случае ответа об успехе платёжная система зачислит голоса на счёт приложения. Если в ответ будет получено сообщение об ошибке, заказ отменяется. `refunded` — заказ отменён. Необходимо забрать игровые ценности, выданные пользователю за платежи. Доступен начиная с версии API 5.132. |
 | `sig` `string` | Подпись уведомления (см. [Проверка подписи уведомления](api/payments/notifications/overview#Проверка%20подписи)) |
 | `item` `string` | Наименование товара, переданное диалоговому окну покупки (см. [Параметры диалогового окна платежей](api/payments/getting-started)). |
 | `item_id` `integer` | Идентификатор товара в приложении. |
 | `item_title` `string` | Название товара. |
 | `item_photo_url` `string` | Изображение товара. |
 | `item_price` `string` | Стоимость товара. |
 | `item_discount` `string` | Размер скидки на товара, если она есть. |

## Параметры ответа

 | Название параметра | Примечение |
 |---|---|
 | `order_id` `integer`, обязательный | Идентификатор заказа в системе платежей ВКонтакте. |
 | `app_order_id` `integer` | Идентификатор заказа в приложении. Должен быть уникальным для каждого заказа.  |

## Пример ответа

```JSON
{
  "response": {
    "order_id": 1111,
    "app_order_id": 6492
  }
}

```

## Пример ответа в случае ошибки

```JSON

{
  "error": {
        "error_code":21, 
        "error_msg":"Нет в наличии",
        "critical":1
    }
}

```

Интеграция | Платежи | Платёжный API | Изменение статуса заказа

# Обработка платёжных уведомлений

Уведомления посылаются сервером платёжной системы на **Адрес обратного вызова**, указанный в настройках приложения, методом `POST` в кодировке UTF-8. 

Чтобы исключить возможность подделки, уведомление подписывается секретным ключом, известным только владельцу приложения и платежной системе, (подробнее в разделе [Проверка подписи](#Проверка%20подписи)). 

Разработчик должен реализовать обработку уведомлений и вернуть результат обработки в случае успеха или описание ошибки в случае неуспеха (см. подробнее в разделе [Формат ответа в случае ошибки](#Формат%20ответа%20в%20случае%20ошибки)). Ответ должен быть отправлен в течение 10 секунд, иначе соединение будет разорвано, а попытка отправки уведомления будет предпринята ещё раз через некоторое время. 

> **Важно!** Ответ должен быть в формате JSON в кодировке UTF-8. 

## Структура уведомления

Набор полей зависит от типа уведомления. Однако уведомление любого типа всегда содержит следующие поля:

### `notification_type`

`string`

Тип уведомления. Возможные значения:  
* `get_item` — получение информации о товаре; 
* `order_status_change` — изменение статуса заказа;  
* `get_subscription` — получение информации о подписке;
* `subscription_status_change` — изменение статуса подписки.  

### `app_id` 

`integer` 

Идентификатор приложения. 

### `user_id` 

`integer`

Идентификатор пользователя, сделавшего заказ. 

### `receiver_id` 

`integer`

Идентификатор получателя заказа (в данный момент совпадает с `user_id`, но в будущем может отличаться). 

### `order_id/subscription_id` 

`integer/integer`

Идентификатор заказа/подписки. 

### `version` 

`string`

Параметр передаётся начиная с версии платежного API 5.132. Используемая версия платёжного API. 

### `sig` 

`string`

Подпись уведомления (подробнее в разделе [Проверка подписи](#Проверка%20подписи)). 

## Версионирование уведомлений

В настройках приложения, в разделе **Платежи** доступно переключение версий платёжных уведомлений. 
Начиная с версии 5.132 становятся доступны новые типы уведомлений — об отменах платежей, а также добавляется параметр `version`, опивающий версию используемого API.

## Проверка подписи

Параметр `sig` равен md5 от конкатенации пар имя параметров=значение параметра, расположенных в порядке возрастания имени параметра (по алфавиту) и секретной подписи `api_secret`, указанной в настройках вашего приложения. 

При несовпадении подписей необходимо выдать в ответе ошибку 10, «Несовпадение вычисленной и переданной подписи» (см. [Формат ответа в случае ошибки](#Формат%20ответа%20в%20случае%20ошибки)). 

Пример формирования подписи с секретным ключом W7kVvxVxZ4: 

```
sig = md5("name1=value1name2=value2W7kVvxVxZ4") 
```

## Формат ответа в случае ошибки

Если при обработке уведомления произошла ошибка, необходимо отправить ответ в следующем формате: 

```JSON
{
  "error": {
    "error_code": код ошибки,
    "error_msg": описание ошибки,
    "critical": критичность ошибки
  }
}
```

## Поля объекта `error`

### `error_code` 

`integer`

 Числовой код ошибки (см. ниже). 

### `error_msg`  

`string`

Описание ошибки в текстовом виде для чтения человеком (обязательно для `error_code >= 100`). 

### `critical` 

`boolean`

Критичность ошибки. Возможные значения:   
* `true`, если повторение уведомления с такими же параметрами приведёт к такой же ошибке (например, указанного товара не существует). Уведомление не будет отправляться повторно, пользователь получит ошибку.  
* `false`, если ошибка временная, и уведомление может быть обработано позже (например, временная ошибка записи в базу данных). Уведомление будет отправлено через некоторое время, пользователь будет ждать ответа.  

## Числовые коды ошибок

 | Код ошибки | Критичность | Описание ошибки в текстовом виде |
|---|---|---|
 | 1 | `true`/`false` | Общая ошибка. |
 | 2 | `false` | Временная ошибка базы данных. |
 | 10 | `true` | Несовпадение вычисленной и переданной подписи. |
 | 11 | `true` | Параметры запроса не соответствуют спецификации;  в запросе нет необходимых полей;  другие ошибки целостности запроса. |
 | 20 | `true` | Товара не существует. |
 | 21 | `true` | Товара нет в наличии. |
 | 22 | `true` | Пользователя не существует. |
 | 100-999 | | Ошибки с номерами 100-999 задаются приложением, при возврате таких ошибок обязательно должно присутствовать текстовое описание ошибки. |

 ## Пример обработчика уведомлений на языке PHP

```PHP
 <?php
header("Content-Type: application/json; encoding=utf-8");

$secret_key = 'hiUl8U4F9q3BcbAl28va'; // Защищённый ключ приложения

$input = $_POST;

// Проверка подписи
$sig = $input['sig'];
unset($input['sig']);
ksort($input);
$str = '';
foreach ($input as $k => $v) {
  $str .= $k.'='.$v;
}

if ($sig != md5($str.$secret_key)) {
  $response['error'] = array(
    'error_code' => 10,
    'error_msg' => 'Несовпадение вычисленной и переданной подписи запроса.',
    'critical' => true
  );
} else {
  // Подпись правильная
  switch ($input['notification_type']) {
    case 'get_item':
      // Получение информации о товаре
      $item = $input['item']; // наименование товара

      if ($item == 'item1') {
        $response['response'] = array(
          'item_id' => 25,
          'title' => '300 золотых монет',
          'photo_url' => 'http://somesite/images/coin.jpg',
          'price' => 5
        );
      } elseif ($item == 'item2') {
        $response['response'] = array(
          'item_id' => 27,
          'title' => '500 золотых монет',
          'photo_url' => 'http://somesite/images/coin.jpg',
          'price' => 10
        );
      } else {
        $response['error'] = array(
          'error_code' => 20,
          'error_msg' => 'Товара не существует.',
          'critical' => true
        );
      }
      break;

    case 'get_item_test':
      // Получение информации о товаре в тестовом режиме
      $item = $input['item'];
      if ($item == 'item1') {
        $response['response'] = array(
          'item_id' => 125,
          'title' => '300 золотых монет (тестовый режим)',
          'photo_url' => 'http://somesite/images/coin.jpg',
          'price' => 5
        );
      } elseif ($item == 'item2') {
        $response['response'] = array(
          'item_id' => 127,
          'title' => '500 золотых монет (тестовый режим)',
          'photo_url' => 'http://somesite/images/coin.jpg',
          'price' => 10
        );
      } else {
        $response['error'] = array(
          'error_code' => 20,
          'error_msg' => 'Товара не существует.',
          'critical' => true
        );
      }
      break;

    case 'order_status_change':
      // Изменение статуса заказа
      if ($input['status'] == 'chargeable') {
        $order_id = intval($input['order_id']);

        // Код проверки товара, включая его стоимость
        $app_order_id = 1; // Получающийся у вас идентификатор заказа.

        $response['response'] = array(
          'order_id' => $order_id,
          'app_order_id' => $app_order_id,
        );
      } else {
        $response['error'] = array(
          'error_code' => 100,
          'error_msg' => 'Передано непонятно что вместо chargeable.',
          'critical' => true
        );
      }
      break;

    case 'order_status_change_test':
      // Изменение статуса заказа в тестовом режиме
      if ($input['status'] == 'chargeable') {
        $order_id = intval($input['order_id']);

        $app_order_id = 1; // Тут фактического заказа может не быть - тестовый режим.

        $response['response'] = array(
          'order_id' => $order_id,
          'app_order_id' => $app_order_id,
        );
      } else {
        $response['error'] = array(
          'error_code' => 100,
          'error_msg' => 'Передано непонятно что вместо chargeable.',
          'critical' => true
        );
      }
      break;
  }
}

echo json_encode($response);
?>
```

Интеграция | Платежи | Платёжный API | Платёжные уведомления | Обработка платёжных уведомлений

# Изменение статуса подписки

Присылается в момент изменения статуса подписки. Обратите внимание, что статус подписки не меняется при продлении (списании нового платежа у пользователя). Вы не получите платёжное уведомление о продлении подписки — оно придёт лишь в том случае, если пользователь откажется её продлевать и отменит подписку.

> **Важно!** В случае получения повторного уведомления типа **Изменения статуса подписки** (с тем же `subscription_id`) ответ должен в точности повторять ответ для исходного уведомления. 

Например, если было отправлено это уведомление, и был получен положительный ответ, но он не дошел до сервера **ВКонтакте**, или по каким-то временным причинам не удалось перевести заблокированные средства на счет приложения сразу после получения ответа, такое же уведомление будет отправлено повторно. При этом не нужно выполнять новый заказ, достаточно просто прислать тот же ответ, что и в предыдущий раз (сохранив у себя `subscription_id` и проверив по нему, что такое уведомление уже приходило). 

Обратите внимание — если подписка отменена по причине отсутствия средств на балансе пользователя, она может быть возобновлена в течение пяти дней (если в течение этих пяти дней пользователь пополнил баланс). В таком случае необходимо возобновлять именно существующую подписку, новую создавать не нужно.

## Параметры уведомления

| Название параметра | Примечание |
| --- | --- |
 | `app_id` `integer`, обязательный | Идентификатор приложения. |
 | `cancel_reason` `string` | Причина отмены. Возможные значения: `user_decision` — подписка отменена по инициативе пользователя; `app_decision` — подписка отменена по инициативе приложения ([`orders.cancelSubscription`](orders.cancelSubscription)); `payment_fail` — подписка отменена в результате ошибки платежа; `unknown` — отменена по другой причине. |
 | `item_id` `string`, обязательный | Идентификатор товара в приложении. |
 | `item_price` `integer`, обязательный | Стоимость. |
 | `notification_type` `string`, обязательный | Тип уведомления. Равен `subscription_status_change` или `subscription_status_change_test`. |
 | `status` `string`, обязательный | Новый статус подписки. Возможные значения: `chargeable` — подписка готова к оплате. Необходимо оформить заказ пользователю внутри приложения. В случае ответа об успехе платёжная система зачислит голоса на счёт приложения. Если в ответ будет получено сообщение об ошибке, заказ отменяется; `active` — подписка оформлена и активна; `cancelled` — подписка отменена. |
 | `next_bill_time` `integer` | Дата следующего платежа. |
 | `pending_cancel` `integer` | Подписка действует до конца платежного периода (`status = active`). |
 | `subscription_id` `integer`, обязательный | Идентификатор подписки. |
 | `user_id` `integer`, обязательный | Идентификатор пользователя. |
 | `sig` `string`, обязательный | Подпись уведомления (см. [Проверка подписи](api/payments/notifications/overview#Проверка%20подписи)). |

## Параметры ответа

 | Название параметра | Примечание |
 | --- | --- |
 | `subscription_id` `integer`, обязательный | Глобальный идентификатор подписки. |
 | `app_order_id` `integer` | Идентификатор заказа в приложении. Должен быть уникальным для каждого заказа.    |

## Пример ответа

```JSON

{
    "response": {
        "subscription_id":1111, 
        "app_order_id":6492
    }
}

```

## Пример ответа в случае ошибки

```JSON

{
  "error": {
    "error_code":21, 
    "error_msg":"Нет в наличии",
    "critical":1
    }
}

```

Интеграция | Платежи | Платёжный API | Изменение статуса подписки

# Публикации ВКонтакте

## Публикации с сайтов

### Share

Для публикации ссылки на страницу вашего сайта используйте виджет [Публикация ссылок](widgets/share) или его упрощенную версию — ссылку вида [`https://vk.com/share.php?url=`](https://vk.com/share.php?url=).

![width=50%;height=200px](a0aafaec2d6784e88292f269935d0dce9d70b14e9fc87ec2bd762190 "-6087573413949829335")

### Другие виджеты

Возможность поделиться с друзьями реализована в нескольких виджетах для внешних сайтов. В каждом из этих случаев к записи на стене пользователя будет прикреплена ссылка на страницу вашего сайта, где размещен виджет:
*  [Виджет комментариев](widgets/comments) — пользователь может поделиться комментарием на своей стене. Параметр `autoPublish` позволяет настроить публикацию по умолчанию.
*  [Виджет «Мне нравится»](widgets/like) — действие **Рассказать друзьям** создает на странице пользователя запись с  опциональным комментарием.
*  [Виджет опросов](widgets/poll) — пользователь может поделиться результатом голосования в опросе. 

## Публикации из приложений

Для публикации записей из клиентских и серверных приложений используйте метод [`wall.post`](method/wall.post). Вы можете обращаться к нему напрямую, используя [классическую схему взаимодействия с API](api/api-requests), из [SDK](sdk/overview), из [Open API](api/open-api/getting-started), если речь идет о приложении-сайте. В Open API и приложениях на vk.com действие потребует подтверждения пользователя.

### Медиаконтент в записи на стене

Чтобы добавить к записи аудио, видео или фото, передайте в параметре `attachments` тип объекта и его строковый идентификатор.

Тип объекта — `audio`, `video`, `photo` или `doc`.

Строковый идентификатор — это строка, включающая идентификатор владельца объекта (`owner_id`) и идентификатор самого объекта (`audio_id`, `video_id` и т.д.).

Например, для фотографии [`photo34_408897832`](https://vk.com/photo34_408897832) в `attachments` нужно передать значение `photo34_408897832`.

```
https://api.vk.com/method/wall.post
?owner_id=-1
&message="Tanya"
&attachments="photo34_408897832"
&access_token={YOUR_ACCESS_TOKEN}
&v=:version
```

Запрос к методу [`wall.post`](method/wall.post) для публикации записи с текстом «Tanya» и прикреплённой фотографией [`photo34_408897832`](https://vk.com/photo34_408897832) на стену сообщества [`club1`](https://vk.com/club1).

Если вы хотите прикрепить новый объект к записи на стене, необходимо сначала загрузить его на сервер ВКонтакте. В зависимости от типа контента используйте один из подходов, описанных [на этой странице](api/upload). Затем используйте идентификатор загруженного объекта в параметре `attachments`.

### Предложенные и отложенные записи

С помощью [`wall.post`](method/wall.post) вы можете работать с предложенными и отложенными записями. Чтобы создать предложенную запись, передайте в `owner_id` идентификатор публичной страницы, в которой текущий пользователь не является руководителем.

Чтобы создать отложенную запись, передайте время публикации в параметре `publish_date`.

Для публикации предложенных и отложенных записей используйте параметр `post_id`, значение для которого можно получить методом [`wall.get`](method/wall.get) с `filter`=`suggests` и `postponed` соответственно.

### Ссылки на внешние сайты

Чтобы добавить к записи сниппет ссылки с внешнего сайта (превью-изображение, заголовок и описание), передайте URL в параметре `attachments`. Например, [`https://yandex.ru/`](https://yandex.ru/). Сниппет генерируется автоматически, более подробно об этом вы можете прочитать в следующем разделе.

## Оформление внешних ссылок

### Данные сниппета

![alt=Сниппет ссылки на внешний сайт в записи на стене;title=Сниппет ссылки на внешний сайт в записи на стене](6532be6f132bb58468fa5d9b40ad6ee64076944dc2dc3dd16ba777eb "-3983918226128625608")

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

А именно:
*  Заголовок. Если на странице есть теги `og:title`, `mrc__share_title` или `twitter:title`, то заголовок будет взят из одного из них (указанного первым), иначе будет использован тег `<title>`. 
*  Иллюстрация. Если на странице есть тег `vk:image`, то адрес изображения для иллюстрации будет взят из него. Если такого тега нет, проверяется содержимое тегов `og:image`, `twitter:image`, `image` — адрес изображения для иллюстрации будет взят из указанного первым, иначе будут взяты первые 8 тегов `<img src="...">`, и из них предложены в качестве иллюстрации те картинки, размер которых по ширине и высоте превышает 160 пикселей. 

Мы рекомендуем использовать картинки размером не менее 510x228 пикселей. В этом случае ссылка будет сопровождаться увеличенной картинкой (510x228 пикселей) в сниппете на стене. Если картинка имеет меньший размер (но не менее 160 пикселей по каждой из сторон), или к записи помимо ссылки прикреплены другие вложения, картинка в сниппете будет уменьшенная — 150x83 пикселя.

Например, указать заголовок и картинку для сниппета можно так: 

```HTML
 <head>
 <meta property="og:title" content="Заголовок страницы" />
 <meta property="vk:image"  content="https://pp.vk.me/c629531/v629531034/3172e/xEBYyER1WE4.jpg" />
</head>
```

Обратите внимание, данные для публикации могут кэшироваться. Если вы изменили данные на своем сайте, а ВКонтакте при публикации отображаются старые значения, сбросьте кэш для ссылки на странице [`pages.clearCache`](method/pages.clearCache).

## Предпросмотр содержимого страниц сайтов

В записях сообщества можно размещать ссылки на статьи, содержимое которых пользователь сможет посмотреть в интерфейсе ВКонтакте без перехода на внешний сайт. В таких записях появляется кнопка **Просмотреть**. Нажав на неё, пользователь увидит содержимое статьи на странице с адресом, начинающимся с `https://vk.com/@`, который будет сформирован автоматически. 

![alt=Кнопка предпросмотра под записью;title=Кнопка предпросмотра под записью](ce804419bf7ada3eef0a74df08aca4e6718180ebed2cc25be2abe7ae "2184200479553297311")

Чтобы подключить предпросмотр для ссылок с вашего сайта, пожалуйста, напишите в [Поддержку](https://vk.com/support?act=new_api). В заявке необходимо указать ссылки на несколько примеров статей, ссылку на сообщество вашего сайта ВКонтакте, а также данные о посещаемости сайта и сообщества.

Интеграция | Публикации | Публикации

# Приватность и права доступа

## Права доступа

Часть методов API подразумевает предварительную [авторизацию](api/access-token/getting-started) пользователя с получением определенных [прав доступа](reference/access-rights). Эта информация отражена в верхней части страницы с описанием любого метода.

Если на странице с описанием сказано, что метод не требует прав доступа, это означает, что для его вызова достаточно простой авторизации без специального scope, однако параметр `access_token` должен присутствовать в запросе.

Если метод работает с информацией, доступной в основной версии сайта без авторизации пользователя (например, имя пользователя с заданным id), для его вызова не требуется передача `access_token`. Такие методы называются открытыми, к ним относится, например, [`users.get`](method/users.get). Следует иметь в виду, что среди такой информации могут встречаться данные, которые пользователь скрыл с помощью [настроек приватности](reference/objects). Настройки приватности для текущего пользователя, в свою очередь, учитываются только при передаче `access_token`, в противном случае в ответе будут содержаться лишь те данные, которые доступны «по умолчанию», т.е. для неавторизованного просмотра от пользователя, который не состоит в друзьях или в черном списке у запрашиваемого.

Так, например, при вызове метода [`wall.get`](method/wall.get) с `access_token` друга запрашиваемого пользователя в ответе будут, в числе прочих, содержаться записи с пометкой «Только для друзей», без передачи `access_token` — только записи с общим доступом.

Также для вызова без `access_token` не передается значение «по умолчанию» входного параметра `user_id(s)`, при необходимости запросить информацию о текущем пользователе его нужно задавать явно.

## Формат приватности

###  Получение приватности 


####  Версия API 5.30 и выше 

Приватность возвращается в API в виде массива из следующих возможных значений:
*  `all` – Доступно всем пользователям;
*  `friends` – Доступно друзьям текущего пользователя;
*  `friends_of_friends` / `friends_of_friends_only` – Доступно друзьям и друзьям друзей / друзьям друзей текущего пользователя (`friends_of_friends_only` появился с версии 5.32);
*  `nobody` / `only_me` – Недоступно никому / доступно только мне;
*  `list{list_id}` – Доступно друзьям текущего пользователя из списка с идентификатором [`{list_id}`](method/friends.getLists);
*  `{user_id}` – Доступно другу с идентификатором `{user_id}`;
*  `-list{list_id}` – Недоступно друзьям текущего пользователя из списка с идентификатором [`{list_id}`](method/friends.getLists);
*  `-{user_id}` – Недоступно другу с идентификатором `{user_id}`.

#####  Пример: 

Доступно всем пользователям, кроме друзей из списка №2 и кроме друга `id1234`:

```
privacy_view: ['all', '-list2', -1234]
```

####  Версия API ниже 5.30 

Приватность возвращается в API в виде объекта, содержащего следующие поля:
* `type` – Тип приватности, может быть равен:
   * `nobody` – Ни один пользователь; 
   * `all` – Все пользователи;
   * `friends` – Друзья текущего пользователя;
   * `friends_of_friends` – Друзья друзей текущего пользователя;
   * `users` – Определенный список пользователей, переданный в поле `users`.
* `lists` – Массив из пользовательских списков, которые добавляются к пользователям принадлежащим к типу в поле `type`;
* `except_lists` – Массив из пользовательских списков, которые исключаются из пользователей принадлежащих к типу в поле `type`;
* `users` – Массив из идентификаторов пользователей, которые добавляются к пользователям принадлежащим к типу в поле `type`;
* `except_users` – Массив из идентификаторов пользователей, которые исключаются из пользователей принадлежащих к типу в поле `type`;

#####  Пример:

Доступно друзьям пользователя, кроме друзей из списков №25 и №27

```
privacy_view: {
 type: 'friends',
 except_lists: [25, 27](25%2C_27)
}
```

###  Указание приватности 

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

####  Версия API 5.30 и выше 

Значение приватности передается в виде списка строк, разделенных запятыми, из следующих возможных значений:
*  `all` – Доступно всем пользователям;
*  `friends` – Доступно друзьям текущего пользователя;
*  `friends_of_friends` – Доступно друзьям друзей текущего пользователя;
*  `nobody` / `only_me` – Недоступно никому / доступно только мне;
*  `list{list_id}` – Доступно друзьям текущего пользователя из списка с идентификатором [`{list_id}`](method/friends.getLists);
*  `{user_id}` – Доступно другу с идентификатором `{user_id}`;
*  `-list{list_id}` – Недоступно друзьям текущего пользователя из списка с идентификатором [`{list_id}`](method/friends.getLists);
*  `-{user_id}` – Недоступно другу с идентификатором `{user_id}`.

#####  Пример: 

```
friends,-list2,-1234
```

####  Версия API ниже 5.30 

####  Простые значения приватности 

* `0` — Все пользователи;
* `1` — Только друзья;
* `2` — Друзья и друзья друзей;
* `3` — Только я.

####  Некоторые друзья 

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

```
users: friendId, friendId, ...
```

#####  Пример: 

```
users: 1, 6492
```

####  Некоторые списки друзей 

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

```
lists: listId, flistId, ...
```

Списки друзей вы можете получить используя метод [friends.getLists](method/friends.getLists).

#####  Пример: 

```
lists: 1, 2
```

Использование API | Ключ доступа | Приватность и права доступа

# Client Credentials Flow для получения сервисного ключа доступа

> **Важно!** Способ получения ключа доступа, о котором рассказывает эта страница, **устарел**. В скором времени он **перестанет работать**. Не используйте его при разработке нового кода. Если вы применяете этот способ в существующих приложениях — обновите их. Для работы с API используйте [сервисный ключ доступа](mini-apps/management/settings) из настроек приложения. [Подробности](reference/roadmap).

&nbsp;

Схема **Client Credentials Flow** предполагает получение сервисного ключа доступа через API-вызов. Полученный ключ можно использовать для работы с API-методами группы [`secure`](method/secure).

## Как получить ключ

### Запрос

Для получения сервисного ключа доступа отправьте следующий GET-запрос:

```
https://oauth.vk.com/access_token?client_id= + CLIENT_ID + &client_secret= + CLIENT_SECRET + &v=:version&grant_type=client_credentials
```

В URL запроса передайте следующие параметры:

| Параметр | Описание |
| --- | --- |
| `client_id`&#x0d;&#x0a;*обязательный* | Идентификатор вашего приложения.&#x0d;&#x0a;Вы можете найти его в настройках приложения ([Настройки](mini-apps/management/settings) &rarr; **ID приложения**). |
| `client_secret`&#x0d;&#x0a;*обязательный* | Защищённый ключ вашего приложения.&#x0d;&#x0a;Вы можете найти его в настройках вашего приложения ([Настройки](mini-apps/management/settings) &rarr; **Защищённый ключ**). |
| `grant_type`&#x0d;&#x0a;*обязательный* | Тип авторизации. Передайте значение `client_credentials`.|  
| `v`&#x0d;&#x0a;*обязательный* | [Версия API](reference/versions), которую вы используете. Актуальная версия: `:version`. |

### Ответ

Сервер ВКонтакте в ответе вернёт значение  `access_token`, которое является значением сервисного ключа доступа вашего приложения.

```JSON
{
  "access_token": "533bacf01e11f55b536a565b57531ac114461ae8736d6506a3"
}
```

## Использование ключа

Это значение можно использовать при отправке API-запросов [`secure`](method/secure). При вызове указывайте ключ в параметре `access_token` запроса.

> **Важно!** Зная секретный ключ приложения, можно от его имени работать с API-методами [`secure`](method/secure) без ведома владельца.
>
> Никогда не передавайте свой секретный ключ третьей стороне и не храните его в открытом виде. Если секретный ключ был скомпрометирован, обязательно измените его в настройках приложения.

Использование API | Ключ доступа | Client Credentials Flow для получения сервисного ключа доступа

# API историй

Статистика историй ВКонтакте — 12 миллионов авторов, 71 миллион историй, 4,4 миллиарда просмотров от 46 миллионов пользователей каждый месяц. Загружать истории с помощью API могут любые пользователи и сообщества.

![](d0618ed378f440b275f817e6cce855080d6a77c542f56f07848f6566 "4448781307036623856")

#### Как работать с API историй

Пошаговая инструкция при работе с API Историй ВКонтакте заключает в себе несколько шагов:

1. Авторизуйте пользователя ВКонтакте [одним из этих способов](api/access-token/getting-started) или с помощью наших SDK для [Android](sdk/android) и [iOS](sdk/ios).
2. Подготовьте историю — фотографию или видео.
3. Если вы разрабатываете мини-приложение, опубликуйте историю с помощью редактора историй (событие [`VKWebAppShowStoryBox`](bridge/VKWebAppShowStoryBox)).
4. Если вы работаете над другим приложением, размещайте историю с помощью методов секции [`Stories`](method/stories). Сначала получите адрес для загрузки с помощью [`stories.getPhotoUploadServer`](method/stories.getPhotoUploadServer), затем загрузите фотографию или видео и сохраните историю, воспользовавшись [`stories.save`](method/stories.save).

История появится в новостях у друзей и подписчиков пользователя в зависимости от настроек приватности. [С помощью API](method/stories) можно также управлять историями и следить за количеством просмотров.

API ВКонтакте | Истории | API историй 

# Стикеры в историях

Интерактивные стикеры — это стикеры в историях, с которыми можно взаимодействовать. Например, «Мнения», «Музыка», «Фото». На платформе VK Mini Apps вы можете создавать собственные интерактивные стикеры — с любым оформлением и функциональностью.

## Зачем это нужно

Этот инструмент позволяет воспользоваться вашим мини-приложением прямо при просмотре истории. Например, пообщаться с автором истории в анонимном чате, заказать товар или услугу, записаться на экскурсию. Стикеры с логотипом вашей компании помогут рассказать о продукте, повысить лояльность к бренду и его узнаваемость. 

## Пример реализации

Посмотреть, как работают интерактивные стикеры, можно на примере мини-приложения [Планы](https://vk.com/plans). В нём пользователю предлагается выбрать вариант совместного досуга с друзьями: пообедать, созвониться, сходить в кино и так далее. Для каждого действия существует свой отдельный интерактивный стикер. 

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

Пользователь публикует историю. Просматривая её, друзья автора могут нажать на интерактивный стикер или на специальную кнопку в правой части истории — и попасть на экран мини-приложения с кнопкой «Хочу!». Когда человек нажмёт на эту кнопку, автор истории получит уведомление в «колокольчик», что друг готов составить ему компанию.

:::carousel
![title=Экран мини-приложения с выбором действия и экран редактора истории с интерактивным  стикером;](6bbc24564c6521921080ef0470c3159c3fbc89c7c262c7d0bd85de6e "-2155430077254898191")
![title=Опубликованная история с интерактивным стикером и экраны мини-приложения;](83f7af3c4e435a48a150d7621875cf91e5ae91e6a77b6acc691907ce "5622990721197478099")
![title=Пример уведомления;](168752632d99a3f871ebe8c7ad7bb91e46bac651f1775e247de9087c "-489840235644126560")
:::

Это только одно из [мини-приложений с новой механикой](https://vk.com/press/mini-apps-stickers). Добавить в свой проект уникальные интерактивные стикеры может любой разработчик: платформа VK Mini Apps бесплатна, а вся документация находится в открытом доступе — в [сообществе VK Mini Apps.](https://vk.com/vkappsdev)

Стикеры в историях

Интеграция | Сообщества и пользователи | Streaming API

Интеграция | Публикации | Загрузка файлов

Интеграция | Сообщества и пользователи | User Long Poll API

# Валидация действия

## Ошибка Validation required

В некоторых случаях ВКонтакте требует прохождения процедуры валидации пользователя, в результате чего начиная с версии API [5.0](reference/versions) (для более старых версий будет запрошена [api/captcha-error](api/captcha-error)) при любом запросе к API будет возвращена следующая ошибка:

**Код ошибки:** 17 
**Текст ошибки:** Validation required 

В сообщении об ошибке передается также следующий параметр:
`redirect_uri` — специально составленный адрес, который необходимо открыть в браузере для прохождения процедуры валидации. 

После прохождения процедуры валидации пользователь будет перенаправлен на служебную страницу: 
```
https://oauth.vk.com/blank.html#{Данные для завершения процедуры разблокировки}
```

В случае успешной валидации после `#` будут переданы: 
```
https://oauth.vk.com/blank.html#success=1&access_token={НОВЫЙ ТОКЕН ПОЛЬЗОВАТЕЛЯ}&user_id={ИДЕНТИФИКАТОР ПОЛЬЗОВАТЕЛЯ}
```

В случае если токен был получен не по `https`-протоколу будет также передан новый `secret`.

В случае неуспешной разблокировки после `#` будут переданы: 
```
https://oauth.vk.com/blank.html#fail=1
```
##  Выполнение методов через окно подтверждения 

Выполнение некоторых методов требует обязательного подтверждения со стороны пользователя. 

### Вызов методов с помощью SDK или OpenAPI 

При вызове методов с помощью [ClientAPI](sdk/javascript), [OpenAPI](api/open-api/getting-started) и [SDK](sdk/overview), окно подтверждения будет показано автоматически, никакие дополнительные действия со стороны разработчика не требуются. После нажатия на кнопку подтверждения метод будет выполнен. В случае отмены действия метод выполнен не будет, а в приложение вернется параметр `cancel=1`.

:::carousel
![](d7c13aca64eb4789037af6b7047d2d50175475b699f7410cc12de2f5 "5797770735596826925")
![](277b1d3afd7887b89ea7ba77d5c6bddabc0045c747e1aa999595d319 "6974556005412117075")
![](3690b45b225ac164cbf54df5d70588e1bfa909bb4e3ef3e76affd7f6 "-2487209145974278695")
:::

### Вызов методов напрямую 

1. Вызвать метод, получить ответ вида
    ```JSON
    {
      "error": {
        "error_code": 17,
        "error_msg": "Validation required: please open redirect_uri in browser",
       ...
        "redirect_uri": "..."
      }
    }
    ```
2. Открыть браузер со страницей, полученной в `redirect_uri`.
3. В случае подтверждения действия пользователем будет возвращен параметр `success=1`, в случае отмены — `cancel=1`.
4. После подтверждения действия пользователем необходимо вызвать требуемый метод повторно и он будет выполнен.

Использование API | Обработка ошибок | Валидация действия

# Сервис распознавания речи

[Сервис распознавания речи ВКонтакте](https://vk.com/voice-tech) позволяет преобразовать аудиозапись в текстовую расшифровку. Сервис использует ASR (Automatic Speech Recognition)&nbsp;— технологию распознавания речи на базе нейросетей, которая считывает голос и переводит его в текст. Эта технология используется ВКонтакте для расшифровки голосовых сообщений, генерации субтитров в видео и многого другого.

В сервисе используются следующие модели распознавания речи:

* Спонтанная — распознавание речи со сленгом и ненормативной лексикой.
* Нейтральная — распознавание разборчивой речи, как в интервью или телешоу.

Сервис можно встроить как в мини-приложение, так и в игру на любой платформе.

## Ограничения

* Поддерживаемые форматы аудиозаписи: OGG, WAV, MP3 в качестве от 16000&nbsp;Гц (16&nbsp;кГц).
* Максимальный размер файла аудиозаписи: 100&nbsp;МБ.
* Суммарная максимальная длительность файлов аудиозаписей в сутки: 100 минут.
* [Ссылка на адрес сервера для загрузки аудиозаписи](method/asr.getUploadUrl) доступна 1 сутки.
* Методы, указанные в разделе [Интеграция](#Интеграция), можно вызвать только с сервисным ключом доступа.
* Поддерживается распознавание только русского языка.

> **Обратите внимание!** Безлимитное использование технологии возможно за дополнительную плату. Об условиях можно узнать, отправив заявку на электронную почту `bizdev@corp.vk.com`.

## Интеграция

Чтобы получить текстовую расшифровку аудиозаписи, встройте методы API в свое приложение. Выполните следующие шаги:

1. [Получите адрес сервера для загрузки аудиозаписи](method/asr.getUploadUrl).
1. [Отправьте аудиозапись по адресу сервера загрузки](#Запрос%20на%20отправку%20аудиозаписи).
1. [Запустите распознавание аудиозаписи](method/asr.process).
1. [Получите результат распознавания аудиозаписи](method/asr.checkStatus).

### Запрос на отправку аудиозаписи

Сформируйте и отправьте POST-запрос по адресу сервера, полученному из метода [`asr.getUploadUrl`](method/asr.getUploadUrl), с файлом аудиозаписи, преобразованным в формат [`multipart/form-data`](https://ru.wikipedia.org/wiki/Multipart/form-data).

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

```HTTP
POST https://pu.vk.com/gu/speech/v2/upload?token=eyJ0e13iOiJKV1QiLCJhbGmdOiJIUzI1NiJ9.eyqlmAQiOjE2NjM1OTAzNDYsInZrX3VzZXJfaWQiOjgxNDI3MDksInZrX2FwcF9pZCI6ODE0MjcwOSwidmtfdXBsb2FkX3R5cGUiOiJzcGVlY2gifQ.9PStNUU8cf-rlFdPhM5hKQ2xSjhbxzxy7SRKYHvXC_M HTTP/1.1

Content-Type: multipart/form-data

{
  "file": "\x9b\x9f\xf4\xac\xce\xb5\xac,\xf1o,\x9e6\xf3\xadQl\xb4.3~.\xaf\xa8\xb3\x95/\xd4\xbf\xdd\xaf\x06\x96\x100\..."
}
```

Пример успешного ответа:

```HTTP
HTTP/1.1 200 OK
Content-Type: application/json

{
  "sha": "894e6ab2092d7d2bb093dc8f7e5c60d0ce09c2ane698121c53fefcdc",
  "secret": "1248134271945096002",
  "meta": {
    "duration": "43.6652",
    "size": "1065633",
    "type": "ogg"
  },
  "hash": "50a9f8dasf073969e92ca20ad47031e6",
  "server": "230305",
  "user_id": 123,
  "request_id": "19d5e34ca1e740e283dfc844027a1df7",
  "app_id": 123
}
```

Пример ответа с ошибкой:

```HTTP
HTTP/1.1 200 OK
Content-Type: application/json

{
  "request_id": "19d5e34ca1e740e283dfc844027a1df7",
  "error_code": 123,
  "error_msg": "Internal Server Error"
}
```

Интеграция | Распознавание речи | Сервис распознавания речи

Условия размещения приложений на сайте VK.com

Правила | Оферта на оказание услуг по привлечению пользователей к Сайту

Правила | Оферта на оказание услуг по размещению рекламы

Оферта о заключении договора оказания услуг от 21.10.2021

# Одобренные способы оплаты

> **Важно!**
>
> Обратите внимание, что приложения-магазины **не могут** использовать как средство оплаты **SMS-платежи и подписки**.
>

В приложениях, соответствующих [требованиям к магазинам ВКонтакте](market-rules), разрешено использовать следующие внешние платёжные системы:
* QIWI Кошелёк
* WebMoney
* Яндекс.Деньги
* Google Checkout
* Paypal
* Money Mail
* RBK Money
* Robokassa
* 2pay
* Деньги-Онлайн
* Intellect Money
* Moneta.ru
* А также все платёжные шлюзы, осуществляющие приём банковских карт (Assist, Cyberplay, Platezh.ru и другие). Помимо указанных платёжных систем к оплате может также приниматься **оплата курьеру во время доставки** и **оплата товара наложенным платежом при получении**.

Правила | Одобренные способы оплаты

# Правила для ботов

**1.** Ботам запрещено использовать подписку на сообщество, отметки «Нравится», репосты и подписку на рассылку как обязательное условие работы бота. Полная или частичная функциональность ботов не должна зависеть от того, является пользователь участником сообщества, поставил ли он отметку «Нравится», сделал ли он репост и подписался ли на рассылку. Например, если основная функция бота — обрабатывать фотографии, то он не может делать это только после подписки на сообщество.
**1.1.** Примеры запрещённых условий: «Чтобы получить арт, подпишись на меня», «Эта возможность доступна только подписчикам», «Если хочешь продолжить игру, сделай репост закреплённой записи и поставь лайк на аватар» и подобные. Такие просьбы недопустимы в переписке с пользователями, приветственном сообщении, на стене сообщества и т. д.
**1.2.** Разрешено устраивать раздачи и конкурсы на стене сообщества, благодаря которым участники могут получить пользу (игровую валюту, дополнительные жизни, бесплатные выполнения команд в платных ботах и т. д.), сделав репост, поставив лайк или написав комментарий. Например: «Раздаём 100 монет всем, кто сделает репост», «10 дополнительных бесплатных артов за репост» и т. д. 
**1.2.1.** Любые раздачи и конкурсы должны соответствовать [Правилам проведения конкурсов ВКонтакте](https://vk.com/page-59800369_53731448).

**2.** Если бот обещает выполнить какую-то функцию (обработать фото или видео, прислать ключ, анекдот и так далее), то должен сделать это в течение суток с момента запроса пользователя. 
**2.1.** Если бот не работает по техническим причинам, информация об этом должна быть размещена на видном месте в его сообществе. 
**2.2.** Если бот должен выполнить функцию в будущем — в ответ на вызов команды бот должен прислать информацию о времени выполнения команды. Например, если результат работы команды зависит от внешних факторов, таких как события, мероприятия, или если команда является запланированным напоминанием. Взаимодействие с ботом при этом не должно быть заблокировано.

**3.** Просьбы подписаться на сообщество, поставить лайк, сделать репост и т. д.
**3.1.** Пока бот обрабатывает запрос от пользователя и не выполнил свою команду, ему не следует отправлять такие просьбы. Примеры неправильного ответа: «Пока ждёшь арт, подпишись», «Запрос принят в обработку, не забудь поставить лайк на закреплённую запись». 
**3.2.** Подобные просьбы недопустимы в приветственном сообщении сообщества. 
**3.3.** Подобные просьбы разрешено рассылать не более одного раза в сутки и только после выполнения основной функции бота.
**3.4.** Подобные просьбы разрешено отправлять только в сообщениях, которые отвечают за запрос пользователя, например: «Держи обработанную фотографию. Если тебе нравится наш бот — подпишись на сообщество, чтобы быть в курсе всех новостей».

**4.** Название команды должно ясно и чётко отражать действие, которое произойдёт в результате её выполнения.
**4.1.** Если по команде бота пользователю будут предложены ссылки на другие сообщества или сайты, не имеющие прямого отношения к боту или касающиеся его косвенно, команда должна иметь соответствующее название или содержать предупреждение. Например, если при выполнении команды бот пришлёт ссылку на официальный сайт партнёра, команда должна так и называться: «Ссылка на оф. сайт партнёра».
**4.2.** Запрещено вводить пользователя в заблуждение, намерено указывая неправильные названия команд.

**5.** Основная функциональность бота не должна заключаться в постоянном или периодическом уводе на другие сайты, за исключением ботов, созданных специально для поиска товаров, услуг и иной полезной информации. 

**6.** Бот может отправлять рекламные сообщения / рассылки пользователю, если они соответствуют [Правилам размещения рекламы в сообществах](https://vk.com/page-59800369_53731475) и [Правилам монетизации ботов](bots-rules#Правила%20монетизации%20ботов).

**7.** Администрация Сайта имеет право отключить бота, если он не соответствует вышеперечисленным правилам или противоречит стандартам Администрации. 
**7.1.** Любые рекламные сообщения / рассылки в многопользовательские беседы запрещены. При нарушении этого правила сообществу будут отключены сообщения.

**8.** При отправке сообщений, содержащих пользовательский контент, необходимо [передавать его источник](api/bots/development/messages#Сообщения%20с%20пользовательским%20контентом). Им может быть: фотография из альбома, запись, комментарий, сообщение и т. д. Наличие источника позволит избежать блокировок, если пользователи будут отправлять запрещённые [Правилами платформы](https://vk.com/terms) материалы, и может быть полезно любым ботам, пересылающим пользовательский контент. Например, ботам, позволяющим людям общаться между собой, или дейтинг-ботам с анкетами, в которых можно добавлять фотографии, указывать информацию о себе и т. д., особенно в тех случаях, когда её видят другие пользователи чат-бота.

## Правила монетизации ботов
Вы можете монетизировать бота следующими способами: 
**1.** Платная подписка. 
**1.1.** Бот может выполнять свои команды платно: давать пользователям необходимую информацию и удовлетворять их запросы за вознаграждение. Разработчик сам определяет стоимость запроса, а также настраивает систему оплаты. 
**1.2.** Бот может работать по платным подпискам разных уровней доступа к возможностям бота. 
**1.3.** Информация о платных вариантах работы бота должна быть легкодоступна и хорошо видна. Например, в меню сообщества, приветственном сообщении или в закреплённой записи. 
**1.4.** Пример платной подписки: «Получить дополнительно ещё 10 фотографий можно, оплатив 50 рублей», «Купите 30 дней неограниченного использования всех возможностей бота за 490 рублей».

**2.** Бот может просить подписаться на рекламную рассылку. Сообщения из этой рассылки пользователь должен получать не чаще, чем один раз в семь дней. 
**2.1.** За подписку на рекламную рассылку бот может предлагать выполнение какой-то команды или бонусы (это может быть игровая валюта, бесплатное выполнение платных команд бота и другое).
**2.2.** Попросить подписаться на рассылку можно в приветственном сообщении, которое задается в настройках сообщества, в основном меню бота или в его подменю. Например, можно сделать следующую структуру: «Основное меню» -> «Управление рассылкой» -> «Подписаться на рекламную рассылку». При этом запрещено просить подписаться на рассылку во время выполнения команд пользователя или в процессе взаимодействия с ботом.
**2.3.** Просьба подписаться на рассылку и кнопка, которая выполняет подписку, должна в явном виде давать понять пользователю, что он будет подписан на рекламную рассылку и будет получать сообщения не чаще, чем один раз в семь дней. 
**2.4.** После нажатия на кнопку подписки бот должен написать пользователю, что тот подписан на рекламную рассылку, и указать способ отписки. 
**2.5.** Каждое сообщение рекламной рассылки должно сопровождаться кнопкой для отписки от рассылки. 
**2.6.** Сообщение должно быть помечено интентом — `promo_newsletter`.

**3.** Бот может получить доступ к Рекламному API, если он проходит по критериям, описанным в пункте **3-1**, и прошёл модерацию командой ВКонтакте. 
**3.1.** Критерии:
**3.1.1.** Среднесуточная аудитория бота за последние 30 дней — не менее 50К пользователей.
**3.1.2.** Бот включён в сообществе более трёх месяцев.
**3.1.3.** К сообществу бота не применялось каких-либо наказаний за нарушения правил сайта за последние полгода.
**3.1.4.** Администрация оставляет за собой право отказать боту в доступе к Рекламному API, если он не соответствует правилам или противоречит стандартам Администрации.
**3.2.** После прохождения модерации бот сможет отправлять сообщения, используя Рекламный API.
**3.2.1.** В диалоге с ботом пользователю будет показано предупреждение о том, что этот бот может присылать рекламные сообщения.
**3.3.** Бот может отправлять рекламу пользователю не более одного раза в сутки и только после выполнения своей основной функции. При этом бот предварительно должен спросить у пользователя разрешение на показ рекламы.
**3.3.1.** Сообщение с приглашением получить рекламу должно в явном виде быть помечено как реклама (внутри сообщения текстом должно быть написано, что это реклама / партнёрский материал / акция и т. д.). Хороший пример такого сообщения: «Сообщение от партнёра: „Привет! Сегодня твоя анкета популярнее других. У меня есть несколько свободных мест на кастинг для фотомоделей. Одно из этих мест я решил отдать тебе. Это уникальная возможность пройти обучение и стать топ-моделью. Хочешь узнать больше?“»
**3.3.2.** Сообщение с предложением получить рекламу должно быть помечено интентом `bot_ad_invite`.
**3.3.3.** В ответ на приглашение получить рекламу пользователь может согласиться получить рекламу или отказаться от получения рекламы. 
**3.3.4.** Пользователь должен иметь возможность продолжить пользоваться ботом после отказа получить рекламу. 
**3.3.5.** Рекламное сообщение должно отправляться пользователю только после его согласия получить рекламу и должно отмечаться интентом `bot_ad_promo`.
**3.3.6.** Сообщение с предложением получить рекламу и рекламное сообщение должно соответствовать 
[правилам платформы](https://vk.com/terms) и [правилам размещения рекламы](https://vk.com/page-59800369_53731475).
**4.** При нарушении правил, перечисленных в разделе [Правила монетизации ботов](#Правила%20монетизации%20ботов), сообществу будут отключены сообщения.
**5.** Бот, которого наказали за нарушение правил сайта, автоматически отключается от возможностей Рекламного API. Получить разрешение для повторного подключения он может через Поддержку, если произошла ошибка. Либо через полгода, согласно критериям отбора сообществ.

Правила | Правила для ботов

# VKWebAppAddToCommunity

`VKWebAppAddToCommunity` вызывает окно выбора сообщества и устанавливает в него мини-приложение.

:::note
**Важно!** Перед вызовом события установите флажок [Разрешить установку в сообществах](mini-apps/management/information#Разрешить%20установку%20в%20сообществах) и [включите мини-приложение](mini-apps/management/settings#Состояние).
:::

## Пример

```JavaScript
bridge.send('VKWebAppAddToCommunity')
  .then((data) => { 
    if (data.group_id) {
      // Мини-приложение установлено в сообщество
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

—

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppAddToCommunityResult` и `VKWebAppAddToCommunityFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

Возможные ошибки:

* `This action cannot be performed in the background`, если мини-приложение запущено в фоновом режиме.
* `User denied`, если пользователь закрывает окно выбора сообщества.

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `group_id` | `string` | Идентификатор сообщества, в котором установлено мини-приложение. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppAddToCommunityResult`

Сигнализирует, что мини-приложение установлено в сообщество. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppAddToCommunityResult",
    data: {
      group_id: "166562603"
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppAddToCommunityFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppAddToCommunity](https://vk.cc/bZfqOq) 


VK Bridge | Сообщества | VKWebAppAddToCommunity

# VKWebAppAddToFavorites

`VKWebAppAddToFavorites` показывает окно с предложением добавить мини-приложение или игру в избранное.

## Пример

```JavaScript
bridge.send('VKWebAppAddToFavorites')
  .then((data) => { 
    if (data.result) {
      // Мини-приложение или игра добавлены в избранное
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

—

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppAddToFavoritesResult` и `VKWebAppAddToFavoritesFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

Возможные ошибки:

* `This action cannot be performed in the background`, если мини-приложение или игра запущены в фоновом режиме.
* `User denied`, если пользователь закрыл окно с предложением добавить мини-приложение или игру в избранное.

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если мини-приложение или игра добавлены в избранное. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий  для всех событий VK Bridge.

### События

#### `VKWebAppAddToFavoritesResult`

Сигнализирует, что данные мини-приложение или игра добавлены в избранное. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppAddToFavoritesResult",
    data: {
      result: true
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppAddToFavoritesFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppAddToFavorites](https://vk.cc/bZfr9p)


VK Bridge | Общие события | VKWebAppAddToFavorites

# VKWebAppAddToHomeScreen

`VKWebAppAddToHomeScreen` показывает окно с предложением добавить ярлык мини-приложения или игры на экран устройства. Чтобы убедиться, что ярлык ещё не был добавлен, вызовите событие [`VKWebAppAddToHomeScreenInfo`](bridge/VKWebAppAddToHomeScreenInfo).

## Пример

```JavaScript
bridge.send('VKWebAppAddToHomeScreen')
  .then((data) => { 
    if (data.result) {
      // Ярлык мини-приложения или игры добавлен на экран устройства
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android

## Параметры

—

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppAddToHomeScreenResult` и `VKWebAppAddToHomeScreenFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

Возможные ошибки:

* `This action cannot be performed in the background`, если мини-приложение или игра запущены в фоновом режиме.
* `User denied`, если пользователь запретил доступ.

### Объект `Promise`

Если вызов к платформе прошёл успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если ярлык мини-приложения или игры добавлен на главный экран устройства. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий  для всех событий VK Bridge.

### События

#### `VKWebAppAddToHomeScreenResult`

Сигнализирует, что ярлык мини-приложения или игры добавлен на главный экран устройства. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppAddToHomeScreenResult",
    data: {
      result: true
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppAddToHomeScreenFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотри раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

VK Bridge | Общие события | VKWebAppAddToHomeScreen

# VKWebAppAddToHomeScreenInfo

`VKWebAppAddToHomeScreenInfo` получает информацию о добавлении ярлыка мини-приложения или игры на главный экран устройства. Чтобы добавить ярлык на главный экран устройства, вызовите событие [`VKWebAppAddToHomeScreen`](bridge/VKWebAppAddToHomeScreen).

## Пример

```JavaScript
bridge.send('VKWebAppAddToHomeScreenInfo')
  .then((data) => { 
    if (data.is_added_to_home_screen) {
      // Информация получена
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android

## Параметры

—

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppAddToHomeScreenInfoResult` и `VKWebAppAddToHomeScreenInfoFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если вызов к платформе прошёл успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующими полями:

| Поле | Тип | Описание |
| --- | --- | --- |
| `is_feature_supported` | `boolean` | Информация о том, можно ли добавить ярлык мини-приложения или игры на главный экран устройства. |
| `is_added_to_home_screen` | `boolean` | Информация о том, установлен ли ярлык мини-приложения или игры на главном экране устройства. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий  для всех событий VK Bridge.

### События

#### `VKWebAppAddToHomeScreenInfoResult`

Сигнализирует, что информация о добавлении ярлыка мини-приложения или игры на главный экран устройства получена. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppAddToHomeScreenInfoResult",
    data: {
      result: true
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppAddToHomeScreenInfoFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppAddToHomeScreenInfo](https://vk.cc/bZfrp6)

VK Bridge | Общие события | VKWebAppAddToHomeScreenInfo

# VKWebAppAddToProfile

`VKWebAppAddToProfile` открывает окно, в котором пользователь может добавить в свой профиль [кнопку вызова мини-приложения](mini-apps/profile-button).

## Пример

```JavaScript
bridge.send('VKWebAppAddToProfile', {
  ttl: 1666076431
  })
  .then((data) => { 
    if (data.visibility) {
      // Кнопка добавлена в профиль
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `ttl` &#x0d;&#x0a;*необязательное* | `integer` | Дата и время отключения кнопки в секундах ([Unix Timestamp](https://www.unixtimestamp.com/)).&#x0d;&#x0a;&#x0d;&#x0a; Если в качестве параметра передать `0`, кнопка будет находиться в профиле пользователя, пока он сам её не отключит. |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppAddToProfileResult` и `VKWebAppAddToProfileFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `visibility` | `string` | Информация о том, кому видна кнопка. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `all` — кнопка видна всем пользователям.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `friends` — кнопка видна только друзьям пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `best_friends` — кнопка видна только близким друзьям пользователя. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий  для всех событий VK Bridge.

### События

#### `VKWebAppAddToProfileResult`

Сигнализирует, что кнопка добавлена в профиль. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppAddToProfileResult",
    data: {
      visibility: "best_friends"
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppAddToProfileFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).


VKWebAppAddToProfile

# VKWebAppAllowMessagesFromGroup

`VKWebAppAllowMessagesFromGroup` показывает окно с запросом прав доступа на отправку сообщений от имени сообщества.

## Пример

```JavaScript
bridge.send('VKWebAppAllowMessagesFromGroup', {
  group_id: 166562603,
  key: 'dBuBKe1kFcdemzB' 
  })
  .then((data) => { 
    if (data.result) {
      // Пользователь разрешил отправку сообщений от имени сообщества
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `group_id` &#x0d;&#x0a;*обязательное* | `integer` | Идентификатор сообщества. |
| `key` &#x0d;&#x0a;*необязательное* | `string` | Произвольная строка. Этот параметр можно использовать для идентификации пользователя. |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppAllowMessagesFromGroupResult` и `VKWebAppAllowMessagesFromGroupFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

Возможные ошибки:

* `User denied`, если пользователь запретил отправку сообщений от имени сообщества.

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если пользователь разрешил отправку сообщений от имени сообщества. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppAllowMessagesFromGroupResult`

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

```JavaScript
{
  detail: {
    type: "VKWebAppAllowMessagesFromGroupResult",
    data: {
      result: true
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppAllowMessagesFromGroupFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

 [VKWebAppAllowMessagesFromGroup](https://vk.cc/bZfqcr)


VK Bridge | Сообщества | VKWebAppAllowMessagesFromGroup

# VKWebAppAllowNotifications

`VKWebAppAllowNotifications` показывает окно с предложением запросить у пользователя разрешение на отправку уведомлений от мини-приложения или игры.  

## Пример

```JavaScript
bridge.send('VKWebAppAllowNotifications')
  .then((data) => { 
    if (data.result) {
      // Разрешение на отправку уведомлений мини-приложением или игрой получено
    } else {
      // Ошибка
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web 

## Параметры

— 

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppAllowNotificationsResult` и `VKWebAppAllowNotificationsFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

Возможные ошибки:

* `This action cannot be performed in the background`, если мини-приложение или игра запущены в фоновом режиме.
* `User denied`, если пользователь закрыл окно с предложением запросить у пользователя разрешение на отправку уведомлений от мини-приложения или игры.

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если разрешение на отправку уведомлений мини-приложением или игрой получено. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppAllowNotificationsResult`

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

```JavaScript
{
  detail: {
    type: "VKWebAppAllowNotificationsResult",
    data: {
      result: true
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppAllowNotificationsFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppAllowNotifications](https://vk.cc/bZfspS)


VK Bridge | Общие события | VKWebAppAllowNotifications

# VKWebAppCallAPIMethod

`VKWebAppCallAPIMethod` получает результат вызова метода API ВКонтакте.

## Пример

```JavaScript
bridge.send('VKWebAppCallAPIMethod', {
  method: 'users.get',
  params: {
    user_ids: '743784474,743784479',
    v: '5.131',
    access_token: 'СЕРВИСНЫЙ_КЛЮЧ_ДОСТУПА'
  }})
  .then((data) => { 
    if (data.response) {
      // Метод API выполнен
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `method` &#x0d;&#x0a;*обязательное* | `string` | Имя вызываемого [метода API](methods). |
| `params` &#x0d;&#x0a;*обязательное* | `object` | Параметры метода API. Возможные поля:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `access_token` (`string`) — [сервисный ключ доступа](mini-apps/management/settings#Сервисный%20ключ%20доступа) или ключ доступа пользователя с соответствующими правами, полученный с помощью события [`VKWebAppGetAuthToken`](bridge/VKWebAppGetAuthToken).&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `v` (`string`) — версия API, используемая для запроса (последняя доступная версия: `:version`).&#x0d;&#x0a; &nbsp;&nbsp; &bullet; другие обязательные параметры метода API. |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppCallAPIMethodResult` и `VKWebAppCallAPIMethodFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `response` | `array[object]` | Результат выполнения метода API. Описание структуры объекта `response` можно найти на странице соответствующего метода. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppCallAPIMethodResult`

Сигнализирует, что метод API выполнен. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppCallAPIMethodResult",
    data: {
      response: [
        {
          id: 743784474,
          first_name: "Персик",
          last_name: "Рыжий",
          can_access_closed: true,
          is_closed: false
        },
        {
          id: 743784479,
          first_name: "Сеня",
          last_name: "Хомяк",
          can_access_closed: true,
          is_closed: false
        }
      ]
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppCallAPIMethodFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppCallAPIMethod](https://vk.cc/bZfnNu)


VK Bridge | Пользователи | VKWebAppCallAPIMethod

# VKWebAppChangeFragment

`VKWebAppChangeFragment` отправляется платформой, если пользователь открывает мини-приложение по ссылке вида: `https://vk.com/app6909581#fragment`.

Если мини-приложение поддерживает [навигацию по хешу](bridge/VKWebAppSetLocation), вы можете перенаправить пользователя на конкретное навигационное состояние этого мини-приложения по ссылке вида: `https://vk.com/app6909581#fragment`.

## Пример

```JavaScript
bridge.subscribe((e) => {
  if (e.detail.type === 'VKWebAppChangeFragment') {
    // Логика мини-приложения
  }
});
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

—

## Обработка события

Если пользователь открывал мини-приложение раньше, его навигационное состояние уже хранится в кеше. Чтобы отобразить правильный экран мини-приложения без перезагрузки WebView:

1. Подпишитесь на событие `VKWebAppChangeFragment` с помощью метода `subscribe`.
1. После получения события откройте экран мини-приложения, который соответствует переданному в событии полю `location`.

:::note
**Примечание.** Событие `VKWebAppChangeFragment` всегда отправляется до события [VKWebAppViewRestore](bridge/VKWebAppViewRestore), что позволяет приложению открыть нужный экран, пока восстановленный из кеша экран ещё не отобразился полностью.
:::

## Результат

`VKWebAppChangeFragment` сигнализирует, что хеш получен. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `location` | `string` | Хеш — строка после символа `#` в URL вида `vk.com/app6909581#`. |

 В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppChangeFragment",
    data: {
      location: "fragment"
    }
  }
}
```

## Пример обработки события

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).


VK Bridge | События жизненного цикла | VKWebAppChangeFragment

# VKWebAppCheckAllowedScopes

`VKWebAppCheckAllowedScopes` проверяет, есть ли у мини-приложения или игры доступ к тем или иным данным пользователя (смотрите раздел [Права доступа](reference/access-rights)).

## Пример

```JavaScript
bridge.send('VKWebAppCheckAllowedScopes', {
  scopes: 'friends,notify'
  })
  .then((data) => { 
    if (data.result) {
      // Права доступа получены
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `scopes` &#x0d;&#x0a;*обязательное* | `string` | Список прав, перечисленных через запятую. Пример: `'friends,notify'`. &#x0d;&#x0a;&#x0d;&#x0a;Возможные права:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `notify` — отправлять уведомления (смотрите раздел [`VKWebAppAllowNotifications`](bridge/VKWebAppAllowNotifications)).&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `friends` — получить список друзей пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `photos` — получить фотографии пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `audio` — получить аудиозаписи пользователя. &#x0d;&#x0a; &nbsp;&nbsp; &bullet; `video` — получить видео пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `stories` — получить истории пользователя. &#x0d;&#x0a; &nbsp;&nbsp; &bullet; `pages` — получить вики-страницы пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `menu` — добавлять ссылку на мини-приложение или игру в меню слева.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `wallmenu` — публиковать записи на стене пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `status` — получить статус пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `notes` — получить заметки пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `messages` — расширенные методы работы с сообщениями.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `wall` — использовать обычные и расширенные методы работы со стеной.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `ads` — использовать расширенные методы работы с [рекламным API](method/ads).&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `offline` — доступ к [API](api/getting-started) в любое время.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `docs` — получить файлы пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `groups` — получить сообщества пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `notifications` — получить оповещения об ответах пользователю.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `stats` — получить статистику сообществ и приложений, в которых пользователь является администратором.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `email` — получить адрес электронной почты пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `adsweb` — работать с кабинетом рекламной сети.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `group_messages` — отправлять сообщения от имени официального сообщества мини-приложения или игры (смотрите раздел [`VKWebAppAllowMessagesFromGroup`](bridge/VKWebAppAllowMessagesFromGroup)).&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `market` — получить товары пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `phone` — получить номер телефона пользователя. |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppCheckAllowedScopesResult` и `VKWebAppCheckAllowedScopesFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующими полями:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `array[object]` | Информация о том, проверен ли доступ к информации пользователя. Поля объекта:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `scope` (`string`) — право доступа.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `allowed` (`boolean`) — информация о том, есть ли право доступа.&#x0d;&#x0a;&#x0d;&#x0a; Возможные значения поля `scope`:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `notify` — отправлять уведомления (смотрите раздел [`VKWebAppAllowNotifications`](bridge/VKWebAppAllowNotifications)).&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `friends` — получить список друзей пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `photos` — получить фотографии пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `audio` — получить аудиозаписи пользователя. &#x0d;&#x0a; &nbsp;&nbsp; &bullet; `video` — получить видео пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `stories` — получить истории пользователя. &#x0d;&#x0a; &nbsp;&nbsp; &bullet; `pages` — получить вики-страницы пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `menu` — добавлять ссылку на мини-приложение или игру в меню слева.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `wallmenu` — публиковать записи на стене пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `status` — получить статус пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `notes` — получить заметки пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `messages` — расширенные методы работы с сообщениями.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `wall` — использовать обычные и расширенные методы работы со стеной.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `ads` — использовать расширенные методы работы с [рекламным API](method/ads).&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `offline` — доступ к [API](api/getting-started) в любое время.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `docs` — получить файлы пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `groups` — получить сообщества пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `notifications` — получить оповещения об ответах пользователю.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `stats` — получить статистику сообществ и приложений, в которых пользователь является администратором.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `email` — получить адрес электронной почты пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `adsweb` — работать с кабинетом рекламной сети.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `group_messages` — отправлять сообщения от имени официального сообщества мини-приложения или игры (смотрите раздел [`VKWebAppAllowMessagesFromGroup`](bridge/VKWebAppAllowMessagesFromGroup)).&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `market` — получить товары пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `phone` — получить номер телефона пользователя.&#x0d;&#x0a;&#x0d;&#x0a; Возможные значения поля `allowed`:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `true` — у мини-приложения или игры есть право доступа.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `false` — у мини-приложения или игры нет права доступа (не было запрошено или пользователь запретил). |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий  для всех событий VK Bridge.

### События

#### `VKWebAppCheckAllowedScopesResult`

Сигнализирует, что права доступа получены. В обработчик события на стороне пользователя передаются следующие данные:

```JavaScript
{
  detail: {
    type: "VKWebAppCheckAllowedScopesResult",
    data: {
      "result": [
        {
          "scope": "friends",
          "allowed": true
        },
        {
          "scope": "notify",
          "allowed": false
        }
      ]
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppCheckAllowedScopesFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).


VK Bridge | Общие события | VKWebAppCheckAllowedScopes

# VKWebAppCheckNativeAds

`VKWebAppCheckNativeAds` проверяет, есть ли доступная для показа реклама указанного формата.

```JavaScript
bridge.send("VKWebAppCheckNativeAds", {"ad_format": "interstitial"});

```

## Платформы

Android, iOS, Web, Mobile Web

## Параметры

* `ad_format` (`string`)
Тип рекламы. Возможные значения: `reward`, `interstitial`.
* `use_waterfall` (`boolean`) 
Только для `ad_format = reward`. Использовать ли механизм показа interstitial рекламы в случае отсутствия rewarded video.


## Результат

Если реклама предзагружена для `ad_format`, генерируется событие `VKWebAppCheckNativeAdsResult`. 

```JSON
{
  "type":"VKWebAppCheckNativeAds",
  "data":{
    "result" : true
  }
}
```

**Поля ответа**
* `result` (`boolean`)
 Значение `true`, если реклама предзагружена. Иначе `false`. 

В случае ошибки генерируется событие `VKWebAppCheckNativeAdsFailed`.

```JSON
{
  "type": "VKWebAppCheckNativeAds",
  "data": {
    "error_type": String
    "error_data": {}
  }
}
```

## Песочница игр

[VKWebAppCheckNativeAds](https://vk.cc/c3ZzRg)

VK Bridge | Реклама | VKWebAppCheckNativeAds

# VKWebAppClose

`VKWebAppClose` закрывает мини-приложение или игру. Если закрываемое мини-приложение или игра были запущены с помощью события [`VKWebAppOpenApp`](bridge/VKWebAppOpenApp), при успешном закрытии в родительское приложение будет передано событие `VKWebAppCloseResult`.

## Пример

```JavaScript
bridge.send('VKWebAppClose', {
  status: 'success',
  payload: {
    name: 'value'
  }})
  .then((data) => { 
    if (data.status) {
      // Событие отправлено
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `status` &#x0d;&#x0a;*обязательное* | `string` | Статус закрытия мини-приложения или игры, передаваемый в родительское приложение. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `success` — мини-приложение или игра закрылись успешно.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `failed` — мини-приложение или игра закрылись с ошибкой. |
| `payload` &#x0d;&#x0a;*необязательное* | `object` | Данные, передаваемые в родительское приложение. |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppCloseResult` и `VKWebAppCloseFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

Возможные ошибки:

* `This action cannot be performed in the background`, если мини-приложение или игра запущены в фоновом режиме.

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующими полями:

| Поле | Тип | Описание |
| --- | --- | --- |
| `status` | `string` | Статус закрытия мини-приложения или игры, передаваемый в родительское приложение. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `success` — мини-приложение или игра закрылись успешно.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `failed` — мини-приложение или игра закрылись с ошибкой. |
| `payload` | `object` | Данные, передаваемые в родительское приложение. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppCloseResult`

Сигнализирует, что событие отправлено. В обработчик события на стороне пользователя передаются следующие данные:

```JavaScript
{
  detail: {
    type: "VKWebAppCloseResult",
    data: {
      status: "success",
      payload: {
        name: "value"
      }
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppCloseFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppClose](https://vk.cc/bZfsEx)


VK Bridge | Общие события | VKWebAppClose

# VKWebAppConversionHit

`VKWebAppConversionHit` позволяет отслеживать [конверсионные действия](https://vk.com/faq16578) пользователей в мини-приложении.

## Пример

```JavaScript
bridge.send("VKWebAppConversionHit", {
    "pixel_code": "VK-Boo-427253-dUuM", 
    "conversion_event": "purchase",
    "conversion_value": 3500
  })

```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

`pixel_code` 
`string`, `required` 
Код пикселя. Например: `VK-Boo-427253-dUuM`. Код пикселя можно найти в [рекламном кабинете](https://vk.com/ads?act=retargeting&show=pixels). 

`conversion_event`
`string`, `required`
Конверсионное действие, которое необходимо отслеживать. Например, чтобы отслеживать добавление товара в корзину, значение `conversion_event` должно быть равно `add_to_cart`, если покупку товара, значение `conversion_event` должно быть равно `purchase`. Список всех возможных значений описан в [документации рекламного кабинета](https://vk.com/faq16578). 

`conversion_value` 
`float`
 Стоимость (ценность) конверсионного события (если есть). Например, если пользователь купил товар за 3500 рублей, значение `conversion_event` должно быть равно `purchase`, а значение `conversion_value` должно быть равно `3500`. 

> Обратите внимание. При создании пикселя в рекламном кабинете можно указывать только идентификатор мини-приложения (поле **Разрешённый Mini App id**). Указывать домен или поддомен не обязательно.

## Результат

После успешного выполнения возвращается событие `VKWebAppConversionHitResult`.

```JSON
{
  "type":"VKWebAppConversionHitResult",
  "data":{
    "result":true
  }
}
```

В случае ошибки генерируется событие `VKWebAppConversionHitFailed`.

```JSON
{ 
  "type": "VKWebAppConversionHitFailed", 
  "data": {
     "error_type": "...",
     "error_data": {
        ...
     }
  }
}
```

VK Bridge | Отслеживание пользователей | VKWebAppConversionHit

# VKWebAppCopyText

`VKWebAppCopyText` копирует переданный текст в буфер обмена.

## Пример

```JavaScript
bridge.send('VKWebAppCopyText', {
  text: 'Этот текст будет скопирован в буфер обмена.'
  })
  .then((data) => { 
    if (data.result) {
      // Текст скопирован в буфер обмена
    } else {
      // Ошибка
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `text` &#x0d;&#x0a;*обязательное* | `string` | Текст, который будет размещён в буфере обмена. |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppCopyTextResult` и `VKWebAppCopyTextFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

Возможные ошибки:

* `This action cannot be performed in the background`, если мини-приложение или игра запущены в фоновом режиме.

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если текст был скопирован в буфер обмена. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppCopyTextResult`

Сигнализирует, что текст скопирован в буфер обмена. В обработчик события на стороне пользователя передаются следующие данные:

```JavaScript
{
  detail: {
    type: "VKWebAppCopyTextResult",
    data: {
      "status": "success",
      "payload": {
        "name": "value"
      }
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppCopyTextFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppCopyText](https://vk.cc/bZfsNa)


VK Bridge | Общие события | VKWebAppCopyText

# VKWebAppCreateHash

`VKWebAppCreateHash` генерирует хеш. Хеш помогает защититься от подмены данных, которые ВКонтакте отправляет мини-приложению или игре, например при показах рекламы.

Чтобы убедиться, что данные приходят именно от сервера ВКонтакте, достаточно [вычислить хеш](#Вычисление%20хеша) и сравнить с тем, что мини-приложение или игра получило в ответе.

## Пример

```JavaScript
bridge.send('VKWebAppCreateHash')
  .then((data) => { 
    if (data.sign) {
      // Хеш сгенерирован
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `request_id` &#x0d;&#x0a;*необязательное* | `string` | Идентификатор запроса. Используется для проверки соответствия запроса и ответа. |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppCreateHashResult` и `VKWebAppCreateHashFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующими полями:

| Поле | Тип | Описание |
| --- | --- | --- |
| `sign` | `string` | Хеш, который генерирует сервер ВКонтакте, используя защищённый ключ и текущее значение времени. Такой же принцип используется для подписи [параметров запуска](mini-apps/development/launch-params). |
| `ts` | `integer` |  Дата и время в секундах, когда хеш был сгенерирован ([Unix Timestamp](https://www.unixtimestamp.com/)). |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий  для всех событий VK Bridge.

### События

#### VKWebAppCreateHashResult

Сигнализирует, что хеш сгенерирован. В обработчик события на стороне пользователя передаются следующие данные:

```JavaScript
{
  detail: {
    type: "VKWebAppCreateHashResult",
    data: {
      sign: "m7TwcoveOwy4BE180UCTwyTkPApprYP81RjrOEuQcos",
      ts: 1664541985
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### VKWebAppCreateHashFailed

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Вычисление хеша

Чтобы вычислить хеш:

1. Добавьте в ответ идентификатор пользователя `user_id` и идентификатор мини-приложения или игры `app_id`.
1. Отсортируйте параметры ответа по ключу (в алфавитном порядке) и объедините пары «ключ=значение» в строку с амперсандом в качестве разделителя.
1. Сериализуйте строку с помощью алгоритма хеширования [HMAC-SHA256](https://ru.wikipedia.org/wiki/HMAC). В качестве ключа используйте защищённый ключ из настроек [мини-приложения](mini-apps/management/settings) или игры. Выбранная реализация HMAC должна использовать хеш-функцию SHA-256.
1. Преобразуйте в строку двоичные данные, полученные на предыдущем шаге. Используйте алгоритм [Base64](https://ru.wikipedia.org/wiki/Base64).

### Пример

```PHP
$sign_param = 'fSibt9N1v3DYflFKFl2qyRk-g3szAKiGDL0p6fYGFSI';

$hash_params = [
  'ts' => 1630076629,
  'request_id' => '123',
];

// Добавляем идентификатор пользователя и мини-приложения или игры к ответу на событие.
$hash_params['user_id'] = 123;
$hash_params['app_id'] = 123;

// Сортируем массив по ключам.
ksort($hash_params);

// Формируем строку вида param_name1=value&param_name2=value.
$sign_params_query = http_build_query($hash_params);

// Получаем хеш-код от строки, используя защищёный ключ приложения (метод HMAC).
$sign = rtrim(strtr(base64_encode(hash_hmac('sha256', $sign_params_query, $client_secret, true)), '+/', '-_'), '=');

// Сравниваем полученную строку со значением из VKWebAppCreateHash.
$status = $sign === $sign_param;

echo ($status ? 'ok' : 'fail')."\n";
```

## Песочница

[VKWebAppCreateHash](https://vk.cc/c6kfQV)


VK Bridge | Общие события | VKWebAppCreateHash

# VKWebAppDenyNotifications

`VKWebAppDenyNotifications` отключает уведомления от мини-приложения или игры. 

## Пример

```JavaScript
bridge.send('VKWebAppDenyNotifications')
  .then((data) => { 
    if (data.result) {
      // Уведомления от мини-приложения или игры отключены
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web 

## Параметры

— 

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`;

* С помощью [событий](#События) `VKWebAppDenyNotificationsResult` и `VKWebAppDenyNotificationsFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если уведомления отключены от мини-приложения или игры. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppDenyNotificationsResult`

Сигнализирует, что уведомления отключены от мини-приложения или игры. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppDenyNotificationsResult",
    data: {
      result: true
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppDenyNotificationsFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppDenyNotifications](https://vk.cc/bZft1F)


VK Bridge | Общие события | VKWebAppDenyNotifications

# VKWebAppDeviceMotionStart

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

## Пример

```JavaScript
bridge.send("VKWebAppDeviceMotionStart", {});

```

## Платформы

Android, iOS

## Параметр (Android)

* `refresh_rate` (`integer`)
Период обновления данных в миллисекундах. Минимальное значение — 20 мс, максимальное — 1000 мс, значение по умолчанию — 1000 мс.

> Период обновления можно задать только для Android-устройств. 

## Пример (Android)

```JavaScript
bridge.send("VKWebAppDeviceMotionStart", {"refresh_rate": 500});

```

## Результат

Событие `VKWebAppDeviceMotionStartResult` отправляется, если отслеживание данных включено.

```JSON
{
  "type": "VKWebAppDeviceMotionStartResult",
  "data": {
    "result": true
  }
}
```

### Поля ответа

* `result` (`boolean`)
Всегда `true`. 

После этого данные отправляются в событии `VKWebAppDeviceMotionChanged`.
Если не удалось включить отслеживание данных, генерируется событие `VKWebAppDeviceMotionStartFailed` с типом и описанием ошибки.

```JSON
{ 
  "type": "VKWebAppDeviceMotionStartFailed", 
  "data": {
     "error_type": "..."
     "error_data": {
        ...
     }
  }
}
```

## Формат данных о вращении устройства

```JSON
{
  "type": "VKWebAppDeviceMotionChanged",
  "data": {
    "alpha": "3.0",
    "beta": "-1.3",
    "gamma": "0.0"
  }
}
```

Событие `VKWebAppDeviceMotionChanged` содержит данные об изменении положения мобильного устройства в пространстве. Положение устройства определяется относительно осей X, Y и Z.

![](1a1d4bb54f27e65014664f4c252d9650bb93be08e211ac3eb7b25ff5 "2179923227318917042")

### Поля объекта `data`

* `alpha` (`number`)
Угол поворота устройства вокруг оси Z (в радианах).  Подразумевается, что устройство вращается в плоскости X/Y. Возможные значения: 
* положительное число (`alpha` < π), если устройство вращается против часовой стрелки, 
* отрицательно число (`alpha` ≥ -π), если устройство вращается по часовой стрелке. 

* `beta` (`number`)
Угол поворота устройства вокруг оси X (в радианах). Если в начальном состоянии устройство лежит в плоскости X/Y, которая параллельна земле, то при вращении вокруг оси X устройство перемещается из горизонтального положения в вертикальное. Возможные значения:  
* положительное число (`beta` < π/2) означает, что в вертикальном положении экран устройства будет обращен к пользователю, 
* отрицательное число (`beta` ≥ -π/2), означает, что в вертикальном положении задняя поверхность устройства будет обращена к пользователю.

* `gamma` (`number`)
Угол поворота устройства вокруг оси Y (в радианах). Если в начальном состоянии устройство лежит в плоскости X/Y, которая параллельна земле, то при вращении вокруг оси Y меняется боковой наклон устройства. Возможные значения:  
* положительное число (`gamma` < π), если правая сторона устройства наклоняется вниз, 
* отрицательное число (`gamma` ≥ -π), если вниз наклоняется левая сторона.

VK Bridge | Данные датчиков | VKWebAppDeviceMotionStart

# VKWebAppDeviceMotionStop

`VKWebAppDeviceMotionStop` останавливает [отслеживание данных о вращении устройства в пространстве](bridge/VKWebAppDeviceMotionStart).

## Пример

```JavaScript
bridge.send("VKWebAppDeviceMotionStop", {});

```

## Платформы

Android, iOS

## Параметры

—

## Результат

Если генерируется событие `VKWebAppDeviceMotionStopResult`, приложение больше не будет получать данные.

```JSON
{
  "type": "VKWebAppDeviceMotionStopResult",
  "data": {
    "result": true
  }
}
```

### Поля ответа

* `result` (`boolean`)
Всегда `true`. 

Если не удалось остановить отслеживание данных, генерируется событие `VKWebAppDeviceMotionStopFailed` с типом и описанием ошибки.

```JSON
{ 
  "type": "VKWebAppDeviceMotionStopFailed", 
  "data": {
     "error_type": "..."
     "error_data": {
        ...
     }
  }
}
```

VK Bridge | Данные датчиков | VKWebAppDeviceMotionStop

# VKWebAppDownloadFile

`VKWebAppDownloadFile` позволяет скачать файл на устройство.

## Пример

### Приложение на JavaScript

```JavaScript
bridge.send("VKWebAppDownloadFile", {"url": "https://sun9-28.userapi.com/c846420/v846420985/1526c3/ISX7VF8NjZk.jpg", "filename": "test.jpg"});
```

### Сайт

```JavaScript
vkBridge.send("VKWebAppDownloadFile", {"url": "https://sun9-28.userapi.com/c846420/v846420985/1526c3/ISX7VF8NjZk.jpg", "filename": "test.jpg"});
```

## Платформы

Android, iOS

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `url` *обязательное* | `string` | Ссылка на файл, который необходимо скачать. |
| `filename` *обязательное* | `string` | Название файла, который будет скачан. |

## Результат

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

```JavaScript
bridge.send("VKWebAppDownloadFile")
.then( (data) => { 
  if (data.result) {
    // Файл скачивается
  }
  else {
    // Ошибка
  }
})
.catch( (error) => {
  // Ошибка
  console.log("Ошибка: " + error.error_type, error.error_data);
});
```

#### `.then()`

В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если файл скачивается.&#x0d;&#x0a;`false` — в ином случае. |

#### `.catch()`

В качестве ответа платформа возвращает объект с информацией об ошибке:

```JSON
{
  "data": {
    "error_type": "...",
    "error_data": {
      ...
    }
  }
}
```

Это общий объект для всех методов VK Bridge. Подробнее о нём можно узнать в описании [обработки результатов](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge).

### События

#### Пример обработки

```JavaScript
// Подписаться на события библиотеки
bridge.subscribe(eventHandler);

// Обработчик событий
function eventHandler(e) {

  switch(e.detail.type) {
    case "VKWebAppDownloadFileResult":
      if (e.detail.data.scrollTop) {
        // Файл скачивается
      }
      else {
        // Ошибка
      }
      break;
    case "VKWebAppDownloadFileFailed":
      // Ошибка
      console.log(e.detail.data.error_type, 
                  e.detail.data.error_data);
      break;

    // ...

  }
}
```

#### VKWebAppDownloadFileResult

`VKWebAppDownloadFileResult` сигнализирует, что файл скачивается.

В обработчик события на стороне пользователя передаётся объект следующей структуры:  

```JavaScript
{
  detail: 
  {
    type: "VKWebAppDownloadFileResult",
    data: {
    "result": true
    }
  }
}
```

В качестве ответа, платформа возвращает объект со следующими полями:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если файл скачивается.&#x0d;&#x0a;`false` — в ином случае. |

#### VKWebAppDownloadFileFailed

`VKWebAppDownloadFileFailed` информирует об ошибке.

В обработчик события на стороне пользователя передаётся объект следующей структуры:

```JavaScript
{
  detail: 
  {
    type: "VKWebAppDownloadFileFailed",
    data: {
      error_type: "...",
      error_data: {
        ...
      },
      request_id: 3
    }
  }
}
```

Это общий объект для всех методов VK Bridge. Подробнее о нём можно узнать в описании [обработки результатов](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge).

VK Bridge | Общие события | VKWebAppDownloadFile

# VKWebAppFlashGetInfo

`VKWebAppFlashGetInfo` запрашивает информацию о фонарике.

## Пример

```JavaScript
bridge.send("VKWebAppFlashGetInfo");
```

## Платформы

Android, iOS

## Параметры

—

## Результат

После успешного выполнения возвращается событие `VKWebAppFlashGetInfoResult`.

```JSON
{
  "type":"VKWebAppFlashGetInfoResult",
  "data":{
    "is_available": true,
    "level": 0.5
  }
}
```

### Структура объекта `data`

* `is_available` (`bool`)
Доступна ли работа с фонариком. Возможные значения: 
`false` — фонарик недоступен, 
`true` — фонарик доступен. 
* `level` (`float`) 
Уровень яркости фонарика от 0 до 1. 

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

```JSON
{ 
  "type": "VKWebAppFlashGetInfoFailed", 
  "data": {
     "error_type": "..."
     "error_data": {
        ...
     }
  }
}
```

## Песочница

[VKWebAppFlashGetInfo](https://vk.cc/bZfrEB)

VK Bridge | Управление фонариком | VKWebAppFlashGetInfo

# VKWebAppGetAds

`VKWebAppGetAds` позволяет получить данные для рекламного баннера, который можно показывать в [игре](games/monetization/ad#Рекламные%20баннеры) или [мини-приложении](mini-apps/monetization/ads#Рекламные%20баннеры).

```JavaScript
bridge.send("VKWebAppGetAds", {});
```

## Платформы

Android, iOS

## Параметры

–

## Результат

Генерируется событие `VKWebAppGetAdsResult`. В объекте `data` содержится вся информация, которая будет отображаться в рекламном баннере. 

```JSON
{
  "type": "VKWebAppGetAdsResult",
  "data": { ... }
}
```

В случае ошибки генерируется событие `VKWebAppGetAdsFailed` с [типом и описанием ошибки](mini-apps/bridge#Обработка%20ошибок%20VK%20Bridge).

```JSON
{
    "type": "VKWebAppGetAdsFailed",
    "data": {
        "error_type": "client_error",
        "error_data": { ... }
    }
}
```

VK Bridge | Реклама | VKWebAppGetAds

# VKWebAppGetAuthToken

`VKWebAppGetAuthToken` показывает окно с запросом доступа у пользователя и получает ключ доступа для работы с API. Чтобы идентифицировать пользователя в мини-приложении, ключ доступа запрашивать не нужно, воспользуйтесь [подписью параметров запуска](mini-apps/development/launch-params). 

:::note
**Примечание.** `window.location`, c которого запрашивается токен, должен совпадать с [URL из настроек](mini-apps/management/settings).
:::

## Пример

```JavaScript
bridge.send('VKWebAppGetAuthToken', { 
  app_id: 6909581, 
  scope: 'friends,status'
  })
  .then((data) => { 
    if (data.access_token) {
      // Ключ доступа пользователя получен
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `app_id` &#x0d;&#x0a;*обязательное* | `integer` | Идентификатор мини-приложения. |
| `scope` &#x0d;&#x0a;*обязательное* | `string` | Список [прав доступа](reference/access-rights), перечисленных через запятую. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `friends` — доступ к списку друзей пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `photos` — доступ к фотографиям.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `video` — доступ к видео.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `stories` — доступ к историям.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `pages` — доступ к вики-страницам.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `status` — доступ к статусу пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `notes` — доступ к заметкам пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `wall` — доступ к методам работы со стеной.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `docs` — доступ к документам.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `groups` — доступ к сообществам пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `stats` — доступ к статистике групп и приложений пользователя, администратором которых он является.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `market` — доступ к товарам.&#x0d;&#x0a;&#x0d;&#x0a; Чтобы получить ключ доступа без дополнительных прав, передайте в поле пустую строку. |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppGetAuthTokenResult` и `VKWebAppGetAuthTokenFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующими полями:

| Поле | Тип | Описание |
| --- | --- | --- |
| `access_token` | `string` | Ключ доступа пользователя. |
| `scope` | `string` | Права доступа, выданные пользователем. Может отличаться от запрошенных прав доступа. |
| `expires` | `integer` | Дата и время секундах, когда время жизни `access_token` истечёт ([Unix Timestamp](https://www.unixtimestamp.com/)). |
| `status` | `boolean` | Индикатор, что событие выполнилось успешно (всегда `true`). |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppGetAuthTokenResult`

Сигнализирует, что ключ доступа пользователя получен. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppGetAuthTokenResult",
    data: {
      access_token: "vk12XyJnfX7mG7PE1MBW...6KV4dcdjVjzwwwSDkX",
      scope: "docs",
      expires: 1665151371,
      status: true
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppGetAuthTokenFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppGetAuthToken](https://vk.cc/bZfnlf)


VK Bridge | Пользователи | VKWebAppGetAuthToken

# VKWebAppGetClientVersion

`VKWebAppGetClientVersion` возвращает информацию о платформе, на которой запущено мини-приложение.

## Пример

```JavaScript
bridge.send('VKWebAppGetClientVersion')
  .then((data) => { 
    if (data.platform) {
      // Данные пользователя получены
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

—

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppGetClientVersionResult` и `VKWebAppGetClientVersionFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующими полями:

| Поле | Тип | Описание |
| --- | --- | --- |
| `platform` | `string` | Платформа, на которой запущено мини-приложение. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `ios` — мобильное приложение для iOS.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `android` — мобильное приложение для Android.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `web` — десктопная версия сайта.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `mobile-web` — мобильная версия сайта. |
| `app` | `string` | Имя хоста приложения на мобильном устройстве, внутри которого запускается мини-приложение. |
| `is_google_services_available` | `boolean` | Информация о том, есть ли на мобильном устройстве сервисы Google. |
| `client_user_agent` | `string` | User-Agent приложения на мобильном устройстве. |
| `build` | `string` | Версия сборки приложения хоста на мобильном устройстве. |
| `is_new_navigation` | `boolean` | Информация о том, включена ли новая навигация в мини-приложении. |
| `is_voice_assistant_available` | `boolean` | Информация о том, доступен ли голосовой помощник Маруся. |
| `install_referrer` | `string` | Идентификатор отслеживания рекламы для Android. |
| `vk_client_exists` | `boolean` | Информация о том, установлено ли приложение ВКонтакте на мобильном устройстве. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий  для всех событий VK Bridge.

### События

#### `VKWebAppGetClientVersionResult`

Сигнализирует, что данные пользователя получены. В обработчик события на стороне пользователя передаются следующие данные:

```JavaScript
{
  detail: {
    type: "VKWebAppGetClientVersionResult",
    data: {
      "platform": "android",
      "version": "5.3.2",
      "app": "vkclient",
      "is_google_services_available": true,
      "client_user_agent": "SAK_1.93(com.vkontakte.android)/7.42-13967 (Android 12; SDK 31; arm64-v8a; samsung SM-A525F; ru; 2186x1080)",
      "build": "13967",
      "is_new_navigation": false,
      "is_voice_assistant_available": true,
      "install_referrer": "com.android.vending",
      "vk_client_exists": true
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppGetClientVersionFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppGetClientVersion](https://vk.cc/bZftjV)


VK Bridge | Общие события | VKWebAppGetClientVersion

# VKWebAppGetCommunityToken 

`VKWebAppGetCommunityToken` показывает окно с запросом прав доступа у пользователя и получает ключ доступа для работы с API от имени сообщества. Получить ключ доступа сообщества может только его администратор.

> **Совет.** Чтобы получить список идентификаторов администрируемых сообществ, вызовите метод [`groups.get`](method/groups.get) с параметром `filter=admin`. Для работы с этим методом необходим [ключ доступа пользователя](bridge/VKWebAppGetAuthToken) с правами `scope=groups`.

## Пример

```JavaScript
 bridge.send("VKWebAppGetCommunityToken", {
   app_id: 6909581,
   group_id: 166562603,
   scope: 'messages'
   });
  .then((data) => { 
    if (data.access_token) {
      // Ключ доступа сообщества получен
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
   
```
   
## Платформы

Android, iOS, Mobile Web, Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `app_id` &#x0d;&#x0a;*обязательное* | `integer` | Идентификатор мини-приложения. |
| `group_id` &#x0d;&#x0a;*обязательное* | `integer` | Идентификатор сообщества. |
| `scope` &#x0d;&#x0a;*обязательное* | `string` | Список [прав доступа](reference/access-rights), перечисленных через запятую. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `stories` — доступ к историям.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `photos` — доступ к фотографиям.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `app_widget` — доступ к [виджетам сообществ](api/community-apps-widgets/getting-started).&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `messages` — доступ к сообщениям сообщества.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `docs` — доступ к документам.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `manage` — доступ к администрированию сообщества. |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppGetCommunityTokenResult` и `VKWebAppGetCommunityTokenFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

Возможные ошибки:

* `This action cannot be performed in the background`, если мини-приложение запущено в фоновом режиме.

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `access_token` | `string` | Ключ доступа сообщества. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppGetCommunityTokenResult`

Сигнализирует, что ключ доступа сообщества получен. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppGetCommunityTokenResult",
    data: {
      access_token: "cc9521551d93ddb290b32648a37a006d87438a67f953dd37e564eb6db1ec28f79d05c16e207f00a0" 
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppGetCommunityTokenFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppGetCommunityToken](https://vk.cc/bZfqzK)


VK Bridge | Сообщества | VKWebAppGetCommunityToken

# VKWebAppGetEmail

`VKWebAppGetEmail` показывает окно с запросом доступа к адресу электронной почты пользователя.

> **Совет.** Если вашему мини-приложению требуется запросить не только адрес электронной почты, но и номер телефона, вызовите [карточку контактов](bridge/VKWebAppGetPersonalCard).

## Пример

```JavaScript
bridge.send('VKWebAppGetEmail')
  .then((data) => { 
    if (data.email) {
      // Доступ к электронной почте получен
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Web

## Параметры

—

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppGetEmailResult` и `VKWebAppGetEmailFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

Возможные ошибки:

* `This action cannot be performed in the background`, если мини-приложение запущено в фоновом режиме.
* `User denied`, если пользователь запретил доступ к адресу электронной почты.

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующими полями:

| Поле | Тип | Описание |
| --- | --- | --- |
| `email` | `string` | Адрес электронной почты пользователя. |
| `sign` | `string` | Подпись полученных данных. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий  для всех событий VK Bridge.

### События

#### `VKWebAppGetEmailResult`

Сигнализирует, что доступ к электронной почте получен. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppGetEmailResult",
    data: {
      email: "persik_ryzhiy@mail.ru",
      sign: "lY_KLjwfRmx9X1_z4iowRz1pTKHL98PW-14XURLWKYI"
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppGetEmailFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Вычисление подписи

Для подписи последовательно объединяются значения:

* Идентификатор мини-приложения `app_id`.
* [Защищённый ключ](mini-apps/management/settings#Защищённый%20ключ) `api_secret`.
* Идентификатор пользователя `user_id`.
* Пара `$field_name.$field_value`, вернувшаяся в событии.

От полученной после объединения строки вычисляется криптографический хеш SHA256 в байтовом представлении, затем хеш кодируется с помощью алгоритма Base64 Encode.

Пример формирования подписи события на PHP, где `app_id = 7770000`, `api_secret = W7kVvxVxZ4`, `user_id = 162447`, `field_name = email`, `field_value = test@gmail.com`:

```PHP
$sign = rtrim(strtr(base64_encode(hash('sha256', '7770000W7kVvxVxZ4162447emailtest@gmail.com', true)), '+/', '-_'), '=');
```

## Песочница

[VKWebAppGetEmail](https://vk.cc/bZfkjJ)


VK Bridge | Пользователи | VKWebAppGetEmail

# VKWebAppGetFriends

`VKWebAppGetFriends` показывает окно выбора друзей из списка и получает информацию о них.

## Пример

```JavaScript
bridge.send('VKWebAppGetFriends')
  .then((data) => { 
    if (data.users) {
      // Данные о пользователях получены
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `multi` &#x0d;&#x0a;*обязательное* | `boolean` | Информация о том, выбрать ли нескольких друзей из списка или одного. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `false` — выбор одного друга из списка (значение по умолчанию).&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `true` — выбор нескольких друзей из списка. |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppGetFriendsResult` и `VKWebAppGetFriendsFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

Возможные ошибки:

* `This action cannot be performed in the background`, если мини-приложение запущено в фоновом режиме.
* `User denied`, если пользователь закрыл окно выбора друзей.

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующими полями:

| Поле | Тип | Описание |
| --- | --- | --- |
| `users` | `array[object]` | Массив объектов пользователей. Объект содержит следующие поля:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `id` (`integer`) — идентификатор пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `first_name` (`string`) — имя пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `last_name` — фамилия пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `sex` — пол пользователя. Возможные значения: &#x0d;&#x0a; &nbsp;&nbsp;&nbsp;&nbsp; &bullet; `1` — женский.&#x0d;&#x0a; &nbsp;&nbsp;&nbsp;&nbsp; &bullet; `2` — мужской.&#x0d;&#x0a; &nbsp;&nbsp;&nbsp;&nbsp; &bullet; `0` — пол не указан.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `photo_200` — URL квадратной фотографии пользователя с шириной 200 пикселей. Если у пользователя отсутствует фотография, возвращается `https://vk.com/images/camera_200.png`. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий  для всех событий VK Bridge.

### События

#### `VKWebAppGetFriendsResult`

Сигнализирует, что данные о пользователях получены. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppGetFriendsResult",
    data: {
      users: [
        {
          id: 743784479,
          sex: 2,
          last_name: "Хомяк",
          first_name: "Сеня",
          photo_200: "https://sun1-88.userapi.com/s/v1/ig2/ffZYc9qa-E8wPmfGsv-7erYVc83oWBUPeZjY0KSt7i7mkJ6y5YgwrNVs8K9E8TfCK8PuWXhu3l6O5cyCnlUSUCl3.jpg?size=200x200&quality=96&crop=26,26,204,204&ava=1"
        },
        {
          id: 743784474,
          sex: 2,
          last_name: "Рыжий",
          first_name: "Персик",
          photo_200: "https://sun1-91.userapi.com/s/v1/ig2/Dcf-SWu7nVYDDldq9oQegiC06VqsSa43-HpDxzPjrvFCUUk9nSevY2Uf9xzm0bxvLfgsTOH6XiiW-zeLcDhPDj_w.jpg?size=200x200&quality=96&crop=26,26,204,204&ava=1"
        }
      ]
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppGetFriendsFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppGetFriends](https://vk.cc/bZflVs)


VK Bridge | Пользователи | VKWebAppGetFriends

# VKWebAppGetGeodata

`VKWebAppGetGeodata` показывает окно с запросом доступа к местоположению пользователя и получает эти данные.

## Пример

```JavaScript
bridge.send('VKWebAppGetGeodata')
  .then((data) => { 
    if (data.available) {
      // Местоположение получено
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

—

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppGetGeodataResult` и `VKWebAppGetGeodataFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующими полями:

| Поле | Тип | Описание |
|---|---|---|
 |`available` | `boolean` или `integer` | Информация о том, доступны ли приложению данные о текущем местоположении пользователя. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `true` или `1` — данные доступны мини-приложению.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `false` или `0` — данные недоступны мини-приложению (остальные поля не возвращаются). Это означает, что пользователь разрешил передавать данные мини-приложению, но запретил доступ к геолокации в настройках операционной системы. |
 |`lat`| `double` | Географическая широта в градусах. Диапазон возможных значений: от `-90` до `90`. |
 |`long` | `double` | Географическая долгота в градусах. Диапазон возможных значений: от `-180` до `180`. |
 |`accuracy` | `double` | Радиус окружности, которая обозначает границу, внутри которой находится пользователь. Широта и долгота — это центр круга, а `accuracy` — его радиус, заданный в метрах. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppGetGeodataResult`

Сигнализирует, что местоположение получено. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppGetGeodataResult",
    data: {
      available: true,
      lat: 78.0217862,
      long: 76.2881822,
      accuracy: 15.024
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppGetGeodataFailed`

Информирует об ошибке, которая произошла при взаимодействии с платформой, или о том, что пользователь не предоставил мини-приложению доступ к данным о своём местоположении.

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppGetGeodata](https://vk.cc/bXLRid)


VK Bridge | Пользователи | VKWebAppGetGeodata

# VKWebAppGetGrantedPermissions

`VKWebAppGetGrantedPermissions` позволяет получить список разрешений, выданных мобильному приложению ВКонтакте.

Чтобы пользователь мог выдать нужные разрешения на iOS, откройте системные настройки устройства. Для этого добавьте в нужное место своего мини-приложения ссылку: 

```HTML
<a href="app-settings:" target="_blank">
```

## Пример

```JavaScript
bridge.send('VKWebAppGetGrantedPermissions')
  .then((data) => { 
    if (data.permissions) {
      // Список разрешений получен
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });  
```

## Платформы

Android, iOS

## Параметры

—

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppGetGrantedPermissionsResult` и `VKWebAppGetGrantedPermissionsFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `permissions` | `array[string]` | Список разрешений, выданных мобильному приложению ВКонтакте. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `camera` — разрешено использовать камеру, чтобы делать фотографии и записывать видео.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `location` — разрешено запрашивать местоположение устройства.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `photo` — доступ к фотографиям и видео на мобильном устройстве с iOS.&#x0d;&#x0a;&#x0d;&#x0a; Пустой результат означает, что никакие разрешения не выданы. Есть ли доступ к фотографиям, можно проверить только на iPhone. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий  для всех событий VK Bridge.

### События

#### `VKWebAppGetGrantedPermissionsResult`

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

```JavaScript
{
  detail: {
    type: "VKWebAppGetGrantedPermissionsResult",
    data: {
      "permissions": [
        "camera",
        "location",
        "photo"
      ]
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppGetGrantedPermissionsFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppGetGrantedPermissions](https://vk.com/app6909581#VktXZWJBcHBHZXRHcmFudGVkUGVybWlzc2lvbnNAJTdCJTdE)


VK Bridge | Общие события | VKWebAppGetGrantedPermissions

# VKWebAppGetLaunchParams

`VKWebAppGetLaunchParams` получает значения [параметров запуска](mini-apps/development/launch-params) мини-приложения или игры.

## Пример
```JavaScript
bridge.send('VKWebAppGetLaunchParams')
  .then((data) => { 
    if (data.vk_app_id) {
      // Параметры запуска получены
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

—

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppGetLaunchParamsResult` и `VKWebAppGetLaunchParamsFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект с полями, описанными в разделе [Параметры запуска](mini-apps/development/launch-params).

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppGetLaunchParamsResult`

Сигнализирует, что параметры запуска получены. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppGetLaunchParamsResult",
    data: {
      sign: "Hb67aIL4cElWINenspCpKu3tUgacikw541NCXX8zWL4",
      vk_access_token_settings: "",
      vk_app_id: 8142709,
      vk_are_notifications_enabled: 0,
      vk_is_app_user: 1,
      vk_is_favorite: 0,
      vk_language: "ru",
      vk_platform: "desktop_web",
      vk_ref: "other",
      vk_ts: 1664886146,
      vk_user_id: 82156740
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppGetLaunchParamsFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).


VK Bridge | Общие события | VKWebAppGetLaunchParams

# VKWebAppGetPersonalCard

`VKWebAppGetPersonalCard` вызывает карточку контактов пользователя с полями, которые вы запросили. Мобильное приложение показывает экран с запросом доступа к выбранным данным.

**Карточка контактов** — это место, где пользователь сохраняет контактные данные (номер телефона, адрес, email), которыми он готов поделиться с сервисами сторонних разработчиков.

Данные в карточке контактов не связаны с данными профиля и живут независимо от них. При этом в интерфейсе вашего мини-приложения пользователь сможет выбрать, какие именно данные из карточки предоставить, или отредактировать данные прямо в процессе запроса доступов.

## Пример

```JavaScript
bridge.send('VKWebAppGetPersonalCard', {
  type: [
    'phone',
    'email',
    'address'
  ]})
  .then((data) => { 
    if (data.phone) {
      // Данные получены
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS

## Параметры

| Поле | Тип | Описание |
|---|---|---|
| `type` &#x0d;&#x0a;*обязательное* | `array[string]` | Массив доступов. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `phone` — номер телефона пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `email` — электронный адрес пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `address` — физический адрес пользователя. |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppGetPersonalCardResult` и `VKWebAppGetPersonalCardFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

Возможные ошибки:

* `This action cannot be performed in the background`, если мини-приложение запущено в фоновом режиме.
* `User denied`, если пользователь запретил доступ к данным.

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующими полями:

| Поле | Тип | Описание |
| --- | --- | --- |
| `phone` | `string` | Номер телефона пользователя. |
| `email` | `string` | Электронный адрес пользователя. |
| `address` | `object` | Информация об адресе пользователя. Поля объекта:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `city` (`object`) —  город пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `country` (`object`) — страна пользователя.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `specified_address` (`string`) — точный адрес, указанный пользователем.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `postal_code` (`string`) — почтовый индекс.&#x0d;&#x0a;&#x0d;&#x0a; Поля объекта `country`:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `id` (`integer`) — идентификатор страны.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `title` (`string`) — название страны.&#x0d;&#x0a;&#x0d;&#x0a; Поля объекта `city`:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `id` (`integer`) — идентификатор города.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `title` (`string`) — название города. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppGetPersonalCardResult`

Сигнализирует, что данные получены. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppGetPersonalCardResult",
    data: {
      phone: "79111234567",
      email: "persik_ryzhiy@mail.ru"
      address: {
        country: {
          id: 1,
          name: "Россия"
        },
        city: {
          id: 2,
          name: "Санкт-Петербург"
        },
        specified_address: "Невский пр., д. 28"
        postal_code: "191186"
      }
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppGetPersonalCardFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).


VK Bridge | Пользователи | VKWebAppGetPersonalCard

# VKWebAppGetPhoneNumber

`VKWebAppGetPhoneNumber` показывает окно с запросом доступа к номеру телефона пользователя.

> **Совет.** Если вам требуется запросить не только номер телефона, но и адрес электронной почты, используйте вызов [карточки контактов](bridge/VKWebAppGetPersonalCard).

## Пример

```JavaScript
bridge.send('VKWebAppGetPhoneNumber')
  .then((data) => { 
    if (data.phone_number) {
      // Номер телефона получен
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Web

## Параметры

—

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppGetPhoneNumberResult` и `VKWebAppGetPhoneNumberFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

Возможные ошибки:

* `This action cannot be performed in the background`, если мини-приложение запущено в фоновом режиме.
* `User denied`, если пользователь запретил доступ к номеру телефона.

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующими полями:

| Поле | Тип | Описание |
| --- | --- | --- |
| `phone_number` | `string` | Номер телефона пользователя. |
| `sign` | `string` | Подпись полученных данных. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppGetPhoneNumberResult`

Сигнализирует, что номер телефона получен. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppGetPhoneNumberResult",
    data: {
      sign: "YdUTMy8uAmFXUqzMsAUjYFTZ1cUfhRJBpTjmqgZBCtg",
      phone_number: "79111234567" 
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppGetPhoneNumberFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Вычисление подписи

Для подписи последовательно объединяются значения:

* Идентификатор мини-приложения `app_id`.
* [Защищённый ключ](mini-apps/management/settings#Защищённый%20ключ) `api_secret`.
* Идентификатор пользователя `user_id`.
* Пара `$field_name.$field_value`, вернувшаяся в событии.

От полученной после объединения строки вычисляется криптографический хеш SHA256 в байтовом представлении, затем хеш кодируется с помощью алгоритма Base64 Encode.

Пример формирования подписи события на PHP, где `app_id = 7770000`, `api_secret = W7kVvxVxZ4`, `user_id = 162447`, `field_name = phone_number`, `field_value = 70000000000`:

```PHP
$sign = rtrim(strtr(base64_encode(hash('sha256', '7770000W7kVvxVxZ4162447phone_number70000000000', true)), '+/', '-_'), '=');
```

## Песочница

[VKWebAppGetPhoneNumber](https://vk.cc/bZfjAn)


VK Bridge | Пользователи | VKWebAppGetPhoneNumber

# VKWebAppGetUserInfo

`VKWebAppGetUserInfo` получает данные о профиле пользователя, который запустил мини-приложение.

## Пример

```JavaScript
bridge.send('VKWebAppGetUserInfo', {
  user_id: 743784474
  })
  .then((data) => { 
    if (data.id) {
      // Данные пользователя получены
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `user_id`  &#x0d;&#x0a;*обязательное* | `integer` | Идентификатор пользователя. |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppGetUserInfoResult` и `VKWebAppGetUserFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующими полями:

| Поле | Тип | Описание |
| --- | --- | --- |
| `id` | `integer` | Идентификатор пользователя. |
| `bdate` | `string` | Дата рождения пользователя. Например 10.4.1990 или 10.4 (если год рождения скрыт). Если дата рождения скрыта целиком, поле в ответе отсутствует. |
| `bdate_visibility` | `integer` | Информация о том, отображается ли дата рождения пользователя. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `1` — дата рождения открыта целиком.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `2` — открыты только день и месяц даты рождения.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `0` — дата рождения скрыта. |
| `city` | `object` | Информация о городе пользователя. Объект, который содержит поля:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `id` (`integer`) — идентификатор города.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `title` (`string`) — название города. |
| `country` | `object` | Информация о стране пользователя. Объект, который содержит поля:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `id` (`integer`) — идентификатор страны.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `title` (`string`) — название страны. |
| `photo_200` | `string` | URL квадратной фотографии пользователя с шириной 200 пикселей. Если у пользователя отсутствует фотография, возвращается `https://vk.com/images/camera_200.png`. |
| `photo_max_orig` | `string` | URL фотографии максимального размера. Может быть возвращена фотография, имеющая ширину как 400, так и 200 пикселей. Если у пользователя отсутствует фотография, возвращается `https://vk.com/images/camera_400.png`. |
| `sex` | `integer` | Пол пользователя. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `1` — женский.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `2` — мужской.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `0` — пол не указан. |
| `photo_100` | `string` | URL квадратной фотографии пользователя с шириной 100 пикселей. Если у пользователя отсутствует фотография, возвращается `https://vk.com/images/camera_100.png`. |
| `first_name` | `string` | Имя пользователя. |
| `last_name` | `string` | Фамилия пользователя. |
| `can_access_closed` | `boolean` | Информация о том, может ли пользователь, который открыл мини-приложение, видеть закрытый профиль пользователя. |
| `is_closed` | `boolean` | Информация о том, закрыт ли профиль пользователя. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий  для всех событий VK Bridge.

### События

#### `VKWebAppGetUserInfoResult`

Сигнализирует, что данные пользователя получены. В обработчик события на стороне пользователя передаются следующие данные:

```JavaScript
{
  detail: {
    type: "VKWebAppGetUserInfoResult",
    data: {
      id: 743784474,
      bdate: "21.12.2000",
      bdate_visibility: 1,
      city: {
        id: 2,
        title: "Санкт-Петербург"
      },
      country: {
        id: 1,
        title: "Россия"
      },
      photo_200: "https://sun1-91.userapi.com/s/v1/ig2/Dcf-SWu7nVYDDldq9oQegiC06VqsSa43-HpDxzPjrvFCUUk9nSevY2Uf9xzm0bxvLfgsTOH6XiiW-zeLcDhPDj_w.jpg?size=200x200&quality=96&crop=26,26,204,204&ava=1",
      photo_max_orig: "https://sun1-91.userapi.com/s/v1/ig2/trHNebJQhG4BmLxC8h4hOpDU6bKRy6uJi586wcyFcCj5fzrwYk7AtoNab-RSil0Bp9b569VQyGK_skG9e6oK7Ap7.jpg?size=256x256&quality=96&crop=0,0,256,256&ava=1",
      sex": 2,
      photo_100: "https://sun1-91.userapi.com/s/v1/ig2/M4vtl7tcmeP6ANUgE0vU7JZWuJszbHaN5QcCcK2xD66EIc6SeSA1NyFVLTSOt2iLOkFhJSJ4DawEJGOjzKtszMpR.jpg?size=100x100&quality=96&crop=26,26,204,204&ava=1",
      first_name: "Персик",
      last_name: "Рыжий",
      can_access_closed: true,
      is_closed: false
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppGetUserInfoFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppGetUserInfo](https://vk.cc/bZfhUc)


VK Bridge | Пользователи | VKWebAppGetUserInfo

# VKWebAppGyroscopeStart

`VKWebAppGyroscopeStart` позволяет приложению получать данные о вращении мобильного устройства от гироскопа, установленного в устройстве.

## Пример

```JavaScript
bridge.send("VKWebAppGyroscopeStart", {});
```

## Платформы

Android, iOS

## Параметр (Android)

* `refresh_rate` (`integer`)
Период обновления данных гироскопа в миллисекундах. Минимальное значение — 20 мс, максимальное — 1000 мс, значение по умолчанию — 1000 мс. 

> Период обновления можно задать только для Android-устройств. 

## Пример (Android)

```JavaScript
bridge.send("VKWebAppGyroscopeStart", {"refresh_rate": 500});

```

## Результат

После успешного выполнения возвращается событие `VKWebAppGyroscopeStartResult`.

```JSON
{
  "type": "VKWebAppGyroscopeStartResult",
  "data": {
   "result": true
  }
}
```

После этого данные гироскопа отправляются в событии `VKWebAppGyroscopeChanged`.
В случае ошибки или отмены действия пользователем генерируется событие `VKWebAppGyroscopeStartFailed`:

```JSON
{
  "type": "VKWebAppGyroscopeStartFailed",
  "data": {
    "error_type": "..."
    "error_data": {
      ...
    }
  }
}
```

## Формат данных гироскопа

```JSON
{
"type": "VKWebAppGyroscopeChanged",
  "data": {
    "x": "3.0",
    "y": "-1.3",
    "z": "0.0"
  }
}
```

Событие `VKWebAppGyroscopeChanged` содержит данные гироскопа о вращении устройства. Знак числа (положительное или отрицательное) указывает на направление вращения.

![](6b9a59ccbb3099e6144a5a56d07aab6ca3b02e9d91ad6bb8285c57b9 "-6293649683936718223")

### Структура объекта `data`

* `x` (`number`)
Скорость вращения устройства вокруг оси X (рад/c). 
* `y` (`number`)
Скорость вращения устройства вокруг оси Y (рад/c). 
* `z` (`number`)
Скорость вращения устройства вокруг оси Z (рад/c).

VK Bridge | Данные датчиков | VKWebAppGyroscopeStart

# VKWebAppInit

`VKWebAppInit` — первое событие, которое ваше приложение должно отправить приложению ВКонтакте для начала работы с VK Bridge. Если это событие не вызвать, ваше мини-приложение или игра не будет работать в мобильных приложениях для iOS и Android, а также в мобильной и десктопной версиях ВКонтакте.

## Пример

```JavaScript
bridge.send('VKWebAppInit')
  .then((data) => { 
    if (data.result) {
      // Приложение инициализировано
    } else {
      // Ошибка
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

—

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppInitResult` и `VKWebAppInitFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если вызов к платформе прошёл успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если приложение инициализировано.&#x0d;&#x0a;`false` — в ином случае. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий  для всех событий VK Bridge.

### События

#### `VKWebAppInitResult`

Сигнализирует, что приложение инициализировано. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppInitResult",
    data: {
      result: true
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppInitFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

VK Bridge | Инициализация | VKWebAppInit

# VKWebAppJoinGroup

`VKWebAppJoinGroup` показывает окно с предложением вступить в сообщество.

## Пример 

```JavaScript
bridge.send('VKWebAppJoinGroup', {
  group_id: 166562603
  })
  .then((data) => { 
    if (data.result) {
      // Пользователь подписался на сообщество
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `group_id` &#x0d;&#x0a;*обязательное* | `integer` | Идентификатор сообщества. |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppJoinGroupResult` и `VKWebAppJoinGroupFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

Возможные ошибки:

* `This action cannot be performed in the background`, если мини-приложение запущено в фоновом режиме.
* `User denied`, если пользователь закрыл окно с предложением вступить в сообщество.

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если пользователь подписался на сообщество. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий  для всех событий VK Bridge.

### События

#### `VKWebAppJoinGroupResult`

Сигнализирует, что пользователь подписался на сообщество. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppJoinGroupResult",
    data: {
      result: true
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppJoinGroupFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppJoinGroup](https://vk.cc/bZfpwU)


VK Bridge | Сообщества | VKWebAppJoinGroup

# VKWebAppLeaveGroup

`VKWebAppLeaveGroup` показывает окно с предложением отписаться от сообщества.

## Пример

```JavaScript
bridge.send('VKWebAppLeaveGroup', {
  group_id: 166562603
  })
  .then((data) => { 
    if (data.result) {
      // Пользователь отписался от сообщества
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `group_id` &#x0d;&#x0a;*обязательное* | `integer` | Идентификатор сообщества. |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppLeaveGroupResult` и `VKWebAppLeaveGroupFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

Возможные ошибки:

* `This action cannot be performed in the background`, если мини-приложение запущено в фоновом режиме.
* `User denied`, если пользователь закрыл окно с предложением отписаться от сообщества.

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если пользователь отписался от сообщества. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppLeaveGroupResult`

Сигнализирует, что пользователь отписался от сообщества. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppLeaveGroupResult",
    data: {
      result: true
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppLeaveGroupFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppLeaveGroup](https://vk.cc/bZfpTr)


VK Bridge | Сообщества | VKWebAppLeaveGroup

# VKWebAppLocationChanged

`VKWebAppLocationChanged` отправляется платформой при изменении значения хеша после символа `#` через событие [`VKWebAppSetLocation`](bridge/VKWebAppSetLocation).

## Пример

```JavaScript
bridge.subscribe((e) => {
  if (e.detail.type === 'VKWebAppLocationChanged') {
    // Логика мини-приложения
  }
});
```

## Платформы

Mobile Web, Web

## Параметры

— 

## Результат

`VKWebAppLocationChanged` сигнализирует, что хеш изменён. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `location` | `string` | Хеш — строка после символа `#` в URL вида `vk.com/app6909581#`. |

 В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppLocationChanged",
    data: {
      location: "fragment"
    }
  }
}
```

## Пример обработки события

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).


VK Bridge | События жизненного цикла | VKWebAppLocationChanged

# VKWebAppOpenApp

`VKWebAppOpenApp` открывает другое приложение (мини-приложение или игру) из текущего приложения (мини-приложения или игры).

## Пример

```JavaScript
bridge.send('VKWebAppOpenApp', {
  app_id: 6909581,
  location: 'test'
  })
  .then((data) => { 
    if (data.result) {
      // Приложение открыто
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `app_id` &#x0d;&#x0a;*обязательное* | `integer` | Идентификатор приложения, которое нужно открыть. |
| `location` &#x0d;&#x0a;*необязательное* | `string` | Хеш — строка после символа `#` в URL вида `vk.com/app6909581#`. |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppOpenAppResult` и `VKWebAppOpenAppFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

Возможные ошибки:

* `This action cannot be performed in the background`, если мини-приложение или игра запущены в фоновом режиме.

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если приложение открыто. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppOpenAppResult`

Сигнализирует, что приложение открыто. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppOpenAppResult",
    data: {
      result: true
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppOpenAppFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppOpenApp](https://vk.cc/bZftvr)


VK Bridge | Общие события | VKWebAppOpenApp

# VKWebAppOpenCodeReader

`VKWebAppOpenCodeReader` открывает камеру для считывания QR- или штрихкода и получает результат сканирования.

## Пример

```JavaScript
bridge.send('VKWebAppOpenCodeReader')
  .then((data) => { 
    if (data.code_data) {
      // Результат сканирования получен
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS

## Параметры

—

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppOpenCodeReaderResult` и `VKWebAppOpenCodeReaderFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

Возможные ошибки:

* `This action cannot be performed in the background`, если мини-приложение или игра запущены в фоновом режиме.
* `User denied`, если пользователь закрыл камеру.

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `code_data` | `string` | Строка, закодированная в QR- или штрихкоде. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppOpenCodeReaderResult`

Сигнализирует, что результат сканирования получен. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppOpenCodeReaderResult",
    data: {
      code_data: "https://vk.com/persik_ryzhiy"
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VVKWebAppOpenCodeReaderFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).


VK Bridge | Общие события | VKWebAppOpenCodeReader

# VKWebAppOpenContacts

`VKWebAppOpenContacts` запрашивает доступ к телефонной книге на устройстве, открывает окно выбора контакта из телефонной книги и получает данные контакта. 

## Пример

```JavaScript
bridge.send('VKWebAppOpenContacts')
  .then((data) => { 
    if (data.phone) {
      // Данные контакта получены
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS

## Параметры

—

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppContactsDone`, `VKWebAppOpenContactsFailed` и `VKWebAppContactsClosed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующими полями:

| Поле | Тип | Описание |
| --- | --- | --- |
| `phone` | `string` | Номер телефона в формате, в котором он хранится в телефонной книге. |
| `first_name` | `string` | Имя пользователя, указанное в телефонной книге. |
| `last_name` | `string` | Фамилия пользователя, указанная в телефонной книге. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppContactsDone`

Сигнализирует, что данные контакта получены. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppContactsDone",
    data: {
      phone: "79217770099",
      first_name: "Персик",
      last_name: "Рыжий" 
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppOpenContactsFailed`

Информирует об ошибке `This action cannot be performed in the background`, если мини-приложение запущено в фоновом режиме.

#### `VKWebAppContactsClosed`

Информирует о закрытии пользователем телефонной книги.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).


VK Bridge | Пользователи | VKWebAppOpenContacts

# VKWebAppOpenPayForm

`VKWebAppOpenPayForm` показывает экран [VK Pay](pay/getting-started) для совершения платежа.

:::note
**Примечание.** Если пользователь ещё не завёл аккаунт VK Pay, при первом вызове ему будет предложено ввести данные для регистрации.
:::

## Пример

```JavaScript
bridge.send('VKWebAppOpenPayForm', {
    app_id: 6909581,
    action: 'pay-to-user',
    params: {
      user_id: 743784474
    }})
  .then((data) => {
    if (data.status) {
      // Экран VK Pay показан
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `app_id` &#x0d;&#x0a;*обязательное* | `integer` | Идентификатор мини-приложения. |
| `action` &#x0d;&#x0a;*обязательное* | `string` | Тип перевода внутри VK Pay. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `pay-to-service` — перевод денежных средств сервису. Доступно только организациям, подключённым через [форму для юридических лиц](https://vk.cc/9CJwZW). Прочтите также документацию, описывающую [расширенный набор параметров](pay/getting-started).&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `pay-to-user` — перевод фиксированных денежных средств пользователю.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `pay-to-group` — перевод фиксированных денежных средств сообществу. Денежные средства будут переведены на баланс получателя, указанного в управлении сообществом.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `transfer-to-group` — перевод произвольных денежных средств сообществу.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `transfer-to-user` — перевод произвольных денежных средств пользователю. |
| `params` &#x0d;&#x0a;*обязательное* | `object` | Параметры платёжной формы VK Pay. Формат и параметры зависят от [типа перевода](pay/getting-started). |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppOpenPayFormResult` и `VKWebAppOpenPayFormFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

Возможные ошибки:

* `This action cannot be performed in the background`, если мини-приложение или игра запущены в фоновом режиме.

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующими полями:

| Поле | Тип | Описание |
| --- | --- | --- |
| `status` | `boolean` | Информация о том, успешно ли выполнен платёж. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `true` — платёж выполнен успешно.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `false` — произошла ошибка. |
| `transaction_id` | `string` | Идентификатор транзакции в платёжной системе. Поле возвращается, если поле `status` имеет значение `true`. |
| `amount` | `string` | Сумма платежа. |
| `extra` | `string` | Дополнительные данные о продавце. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppOpenPayFormResult`

Сигнализирует, что экран VK Pay показан. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppOpenPayFormResult",
    data: {
      status: true,
      transaction_id: "1234ABCD-EEEE-5678-90FG-ABCDEF123456",
      amount: "120.5",
      extra: "{\"currency\":\"RUB\",\"merchant_data\":\"some_merchant_data\",\"merchant_sign\":\"some_sign\",\"order_id\":\"some_order_id\",\"ts\":1641999488}\""
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppOpenPayFormFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

# Песочница

[VKWebAppOpenPayForm](https://vk.cc/bZfweB)


VK Bridge | Платежи | VKWebAppOpenPayForm

# VKWebAppOpenWallPost

`VKWebAppOpenWallPost` открывает в отдельном окне (поверх мини-приложения или игры) запись, опубликованную на стене пользователя или сообщества.

## Пример

```JavaScript
bridge.send('VKWebAppOpenWallPost', {
  owner_id: -166562603,
  post_id: 4604
  })
  .then((data) => { 
    if (data.result) {
      // Окно с записью открыто
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `owner_id` &#x0d;&#x0a;*обязательное* | `integer` | Идентификатор сообщества (отрицательное число) или пользователя (положительное число), на стене которого опубликована запись. |
| `post_id` &#x0d;&#x0a;*обязательное* | `integer` | Идентификатор записи на стене (положительное число). |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppOpenWallPosttResult` и `VKWebAppOpenWallPostFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если окно с записью открыто. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.


### События

#### `VKWebAppOpenWallPostResult`

Сигнализирует, что окно с записью открыто. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppOpenWallPostResult",
    data: {
      result: true
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppOpenWallPostFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppOpenWallPost](https://vk.cc/bZftTD)


VK Bridge | Общие события | VKWebAppOpenWallPost

# VKWebAppRemoveFromProfile

`VKWebAppRemoveFromProfile` удаляет из профиля пользователя [кнопку вызова мини-приложения](mini-apps/profile-button).

## Пример

```JavaScript
bridge.send('VKWebAppRemoveFromProfile')
  .then((data) => { 
    if (data.result) {
      // Кнопка удалена из профиля
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

—

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppRemoveFromProfileResult` и `VKWebAppRemoveFromProfileFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если кнопка удалена. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий  для всех событий VK Bridge.

### События

#### `VKWebAppRemoveFromProfileResult`

Сигнализирует, что кнопка удалена. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppRemoveFromProfileResult",
    data: {
      result: true
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppRemoveFromProfileFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).


VKWebAppRemoveFromProfile

# VKWebAppResizeWindow

`VKWebAppResizeWindow` инициирует изменение ширины и высоты элемента IFrame. 

## Пример

```JavaScript
bridge.send("VKWebAppResizeWindow", {"width": 800, "height": 1000});

```

## Платформы

Web 

## Параметры

* `width` (`integer`, обязательный)
Ширина окна. Может принимать значения от 630px до 1000px.
* `height` (`integer`)
Высота окна. Может принимать значения от 500px до 8050px.

## Результат

После успешного выполнения возвращается событие `VKWebAppResizeWindowResult` с новыми значениями ширины и высоты.

```JSON
{ 
  "type": "VKWebAppResizeWindowResult", 
  "data": { 
    "width": 800, 
    "height": 1000 
  } 
}

```

В случае ошибки генерируется событие `VKWebAppResizeWindowFailed`.

```JSON
{ 
  "type": "VKWebAppResizeWindowFailed", 
  "data": { 
    "error_type": "..." 
    "error_data": { 
      ... 
    } 
  } 
}

```

## Песочница

[VKWebAppResizeWindow](https://vk.cc/bZfsxT)

VK Bridge | Интерфейс и навигация | VKWebAppResizeWindow

# VKWebAppRetargetingPixel

`VKWebAppRetargetingPixel` позволяет добавить пользователя в аудиторию ретаргетинга. Параметры соответствуют параметрам `event` и `audience` при подключении пикселя в [мобильном приложении](https://vk.com/faq14154).

## Пример

```JavaScript
bridge.send("VKWebAppRetargetingPixel", {
 pixel_code: "VK-RTRG-447253-dUuM",
 event: "click-to-button"
});
```

## Платформы

Android (с версии клиента 6.1), iOS, Mobile Web, Web

## Параметры

* `pixel_code` (`string`, `required`)
Код пикселя. Например: `VK-RTRG-447253-dUuM`. 
* `event` (`string`)
Идентификатор события, правило пикселя. 
* `target_group_id` (`integer`) 
Идентификатор группы ретаргетинга, в которую нужно добавить текущего пользователя. 
* `price_list_id` (`integer`)
Идентификатор прайс-листа. Используется для динамического ретаргетинга продуктов. 
* `products_event` (`string`)
Тип продуктового события.  Используется для динамического ретаргетинга продуктов. 
* `products_params` (`string`)
Параметры товара. Используется для динамического ретаргетинга продуктов. 

## Результат

После успешного выполнения возвращается событие `VKWebAppRetargetingPixelResult`.

```JSON
{
  "type":"VKWebAppRetargetingPixelResult",
  "data":{
    "result":true
  }
}
```

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

```JSON
{ 
  "type": "VKWebAppRetargetingPixelFailed", 
  "data": {
     "error_type": "...",
     "error_data": {
        ...
     }
  }
}
```

> Обратите внимание: при создании пикселя в рекламном кабинете можно указывать только идентификатор мини-приложения (поле **Разрешённый Mini App id**). Указывать домен или поддомен не обязательно.

## Примеры соответствия для Open API

Если вы использовали Opеn API (`openapi.js`), ваш JS-код по-прежнему будет работать. Но в будущем мы прекратим поддержку Opеn API и поэтому рекомендуем использовать события VK Bridge так, как показано ниже. 

### `VK.Retargeting.Event`

**Open API** 

```JavaScript
VK.Retargeting.Event("purchase");
```

**VK Bridge**

```JavaScript
bridge.send("VKWebAppRetargetingPixel", {
  pixel_code: "VK-Boo-427253-dUuM",
  event: "purchase"
});
```

### VK.Retargeting.Hit

**Open API**

```JavaScript
VK.Retargeting.Hit();
```

**VK Bridge**

```JavaScript
bridge.send("VKWebAppRetargetingPixel", {
 pixel_code: "VK-Boo-427253-dUuM"
});
```

### VK.Retargeting.Add

**Open API**

```JavaScript
VK.Retargeting.Add(8839163);
```

**VK Bridge**

```JavaScript
bridge.send("VKWebAppRetargetingPixel", {
 "pixel_code": "VK-Boo-427253-dUuM",
 "target_group_id": 8839163
});
```

###  VK.Retargeting.ProductEvent

**Open API**

```JavaScript
VK.Retargeting.ProductEvent(12345 /* PRICE_LIST_ID */, "view_product", {
 "total_price": 34899
});
```

**VK Bridge**

```JavaScript
bridge.send("VKWebAppRetargetingPixel", {
 "pixel_code": "VK-Boo-427253-dUuM",
 "price_list_id": 12345,
 "products_event": "view_product",
 "products_params": {
  "total_price": 34899
 }
});
```

VK Bridge | Отслеживание пользователей | VKWebAppRetargetingPixel

# VKWebAppScroll

`VKWebAppScroll` инициирует прокрутку окна браузера по вертикали. 

## Пример

```JavaScript
bridge.send("VKWebAppScroll", {"top": 1, "speed": 600}); 

```

## Платформы

Mobile Web, Web 

## Параметры

* `top` (`integer`, обязательный)
Смещение прокрутки относительно нулевой координаты окна. Например, чтобы прокрутить окно на самый верх страницы, необходимо передать значение `0`. 
* `speed (integer)`
Скорость анимации в миллисекундах. По умолчанию равна `0`. 

## Результат

После успешного выполнения возвращается событие `VKWebAppScrollResult`.

```JSON
{ 
  "type":"VKWebAppScrollResult", 
  "data": { 
    "top": 1, 
    "height": 2040 
   } 
} 

```

* `top` (`integer`)
Текущее положение прокрутки. 
* `height` (`integer`)
Высота окна после прокрутки пользователем или методом. В случае ошибки генерируется событие `VKWebAppScrollFailed`.

```JSON
{ 
  "type": "VKWebAppScrollFailed", 
  "data": { 
    "error_type": "...",
    "error_data": { 
      ... 
    } 
  } 
} 

```

## Песочница

[VKWebAppScroll](https://vk.cc/bZft21)

VK Bridge | Интерфейс и навигация | VKWebAppScroll

# VKWebAppScrollTopStop

`VKWebAppScrollTopStop` останавливает отправку событий, начатых событием [`VKWebAppScrollTopStart`](bridge/VKWebAppScrollTopStart), из родительского окна в мини-приложение.

## Пример

### Приложение на JavaScript

```JavaScript
bridge.send("VKWebAppScrollTopStop");  
```

### Сайт

```JavaScript
vkBridge.send("VKWebAppScrollTopStop");
```

## Платформы

Web

## Параметры

—

## Результат

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

```JavaScript
bridge.send("VKWebAppScrollTopStop")
.then( (data) => { 
  if (data.result) {
    // Отправка событий остановлена
  }
})
.catch( (error) => {
  // Ошибка
  console.log("Ошибка: " + error.error_type, error.error_data);
});
```

#### `.then()`

В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если отправка событий остановлена. |

#### `.catch()`

В качестве ответа платформа возвращает объект с информацией об ошибке:

```JSON
{
  "data": {
    "error_type": "...",
    "error_data": {
      ...
    }
  }
}
```

Это общий объект для всех методов VK Bridge. Подробнее о нём можно узнать из описания [обработки результатов](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge).

### События

#### Пример обработки

```JavaScript
// Подписаться на события библиотеки
bridge.subscribe(eventHandler);

// Обработчик событий
function eventHandler(e) {

  switch(e.detail.type) {
    case "VKWebAppScrollTopStopResult":
      if (e.detail.data.result) {
        // Отправка событий остановлена
      }
      break;
    case "VKWebAppScrollTopStopFailed":
      // Ошибка
      console.log(e.detail.data.error_type, 
                  e.detail.data.error_data);      
      break;

    // ...    

  }
}        
```

#### VKWebAppScrollTopStopResult

`VKWebAppScrollTopStopResult` сигнализирует, что отправка событий остановлена.

В обработчик события на стороне пользователя передаётся объект следующей структуры:  

```JavaScript
{
  detail: 
  {
    type: "VKWebAppScrollTopStopResult",
    data: {
      "result" : true,
      "scrollTop": "100"
    }
  }
}
```

В качестве ответа платформа возвращает объект со следующими полями:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если отправка событий остановлена.&#x0d;&#x0a;`false` — в ином случае. |
| `scrollTop` | `number` | Текущая позиция прокрутки сверху родительского окна в пикселях. |


#### VKWebAppScrollTopStopFailed

`VKWebAppScrollTopStopFailed` информирует об ошибке.

В обработчик события на стороне пользователя передаётся объект следующей структуры:

```JavaScript
{
  detail: 
  {
    type: "VKWebAppScrollTopStopFailed",
    data: {
      error_type: "...",
      error_data: {
        ...
      },
      request_id: 3
    }
  }
}
```

Это общий объект для всех методов VK Bridge. Подробнее о нём можно узнать из описания [обработки результатов](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge).

VK Bridge | Интерфейс и навигация | VKWebAppScrollTopStop

# VKWebAppSendToClient

`VKWebAppSendToClient` показывает окно с предложением открыть мини-приложение или игру на привязанном к аккаунту мобильном устройстве.

## Пример

```JavaScript
bridge.send('VKWebAppSendToClient')
  .then((data) => {
    if (data.result) {
      // Мини-приложение или игра запущены на мобильном устройстве
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Mobile Web, Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `fragment` &#x0d;&#x0a;*необязательное* | `string` | Хеш — строка после символа `#` в URL вида `vk.com/app6909581#`. |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppSendToClientResult` и `VKWebAppSendToClientFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если мини-приложение или игра запущены на мобильном устройстве. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppSendToClientResult`

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

```JavaScript
{
  detail: {
    type: "VKWebAppSendToClientResult",
    data: {
      result: true
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppSendToClientFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppSendToClient](https://vk.cc/bZfu1G)


VK Bridge | Общие события | VKWebAppSendToClient

# VKWebAppSetLocation

`VKWebAppSetLocation` позволяет установить новое значение хеша (хеш — строка после [https://vk.com/app123#](https://vk.com/app123#), используется для навигации внутри приложения). 

## Пример

```JavaScript
bridge.send("VKWebAppSetLocation", {"location": "hash"}); 

```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

 * `location` (`string`, обязательный)
Новое значение хеша. Символ «#» в параметре указывать не надо. 

## Результат

После успешного выполнения генерируется событие `VKWebAppSetLocationResult`.

```JSON
{ 
  "type": "VKWebAppSetLocationResult", 
  "data": { 
  } 
} 

```

В случае ошибки генерируется событие `VKWebAppSetLocationFailed` с дополнительными данными.

```JSON
{ 
  "type": "VKWebAppSetLocationFailed", 
  "data": { 
     "error_type": "..." 
     "error_data": { 
        ... 
     } 
  } 
} 

```

## Песочница

[VKWebAppSetLocation](https://vk.cc/bZfgkh)

VK Bridge | Интерфейс и навигация | VKWebAppSetLocation

# VKWebAppSetSwipeSettings

`VKWebAppSetSwipeSettings` настраивает в приложении ВКонтакте стандартное поведение жеста «смахнуть назад» (Swipe Back), как в браузере.

## Пример

```JavaScript
bridge.send('VKWebAppSetSwipeSettings', {"history": true});
```

## Платформы

iOS

## Параметры

| Параметр | Тип | Описание |
| --- | --- | --- |
| `history` | `bool` | **Обязательный параметр**. Настройка жеста Swipe Back. Возможные значения:&#x0d;&#x0a;&nbsp;&nbsp; &bullet; `true` — включает стандартное поведение жеста;&#x0d;&#x0a;&nbsp;&nbsp; &bullet; `false` — выключает стандартное поведение жеста. |

## Результат

Если настройка применилась, возвращается событие `VKWebAppSetSwipeSettingsResult` с полем `result` (`boolean`), которое содержит значение `true`.

```JSON
{
  "type": "VKWebAppSetSwipeSettingsResult",
  "data": {
    "result": true
  }
}
```

В случае ошибки возвращается событие `VKWebAppSetSwipeSettingsFailed` с типом, кодом и описанием ошибки.

```JSON
{
  "type": "VKWebAppSetSwipeSettingsFailed",
  "data": {
    "error_type": "client_error",
    "error_data": {
      ...
    }
  }
}
```

## Песочница

[VKWebAppSetSwipeSettings](https://vk.cc/bZsLTe) 

> Только для мобильных устройств!

VK Bridge | Интерфейс и навигация | VKWebAppSetSwipeSettings

# VKWebAppSetViewSettings

## Пример

```JavaScript
bridge.send("VKWebAppSetViewSettings", {"status_bar_style": "dark", "action_bar_color": "#fff"});
```

## Платформы

Android, iOS

## Параметры

* `status_bar_style` (`string`, обязательный)
Тема для иконок статус-бара: `light`, `dark`.
* `action_bar_color` (`string`)
Цвет экшен-бара: hex-код (например, `#00ffff`), `none` – прозрачный. Параметр работает только на Android. 
* `navigation_bar_color` (`string`) 
Цвет навигационного бара: hex-код (например, `#00ffff`). Параметр работает только на Android. 

## Результат

Клиент устанавливает тему для иконок в статус-баре в соответствии с параметром `status_bar_style` и цвет статус-бара в соответствии с параметром `action_bar_color`.
В случае ошибки генерируется событие `VKWebAppSetViewSettingsFailed`.

```JSON
{
  "type": "VKWebAppSetViewSettingsFailed",
  "data": {
    "error_type": "...",
    "error_data": {
      ...
    }
  }
}
```

VK Bridge | Интерфейс и навигация | VKWebAppSetViewSettings

# VKWebAppShare

`VKWebAppShare` показывает окно с предложением разместить на стене пользователя запись с указанной ссылкой.

## Пример

```JavaScript
bridge.send('VKWebAppShare', {
  link: 'https://vk.com/vkappsdev'
  })
  .then((data) => { 
    if (data.result) {
      // Запись размещена
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `link` &#x0d;&#x0a;*обязательное* | `string` | Ссылка, которой необходимо поделиться в записи. По умолчанию — ссылка на текущее мини-приложение или игру вида [http://vk.com/app6909581#hash](http://vk.com/app6909581#hash)). |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppShareResult` и `VKWebAppShareFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает массив объектов со следующими полями:

| Поле | Тип | Описание |
| --- | --- | --- |
| `post_id` | `integer` | Идентификатор записи. |
| `story_id` | `integer` | Идентификатор истории. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppShareResult`

Сигнализирует, что запись размещена. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppShareResult",
    data: {
      result: [
        {
          post_id: 8981
        }
      ]
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppShareFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppShare](https://vk.cc/bZfuA2)


VK Bridge | Общие события | VKWebAppShare

# VKWebAppShowBannerAd

`VKWebAppShowBannerAd` отображает баннерную рекламу в мини-приложении. Чтобы скрыть баннерную рекламу, используйте событие [`VKWebAppHideBannerAd`](bridge/VKWebAppHideBannerAd).

## Пример

```JavaScript
bridge.send('VKWebAppShowBannerAd', {
  banner_location: 'bottom'
  })
 .then((data) => { 
    if (data.result) {
      // Баннерная реклама отобразилась
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `banner_location` &#x0d;&#x0a;*необязательное* | `string` | Расположение баннера. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `top` — баннер будет прижат кверху.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `botom` — баннер будет прижат книзу. Значение по умолчанию. |
| `layout_type` &#x0d;&#x0a;*необязательное* | `string` | Тип фона баннера. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `resize` —  WebView станет меньше на размер баннера. Значение по умолчанию. Поле принимает это значение, если поле `banner_location` имеет значение `top`.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `overlay` — баннер отрисуется поверх WebView. Если нужно сдвинуть контент, разработчик мини-приложения делает это сам. &#x0d;&#x0a;&#x0d;&#x0a; Если поле `banner_location` имеет значение `bottom`, поле может принимать оба значения. |
| `can_close` &#x0d;&#x0a;*необязательное* | `boolean` | Информация о том, отображать ли кнопку закрытия в баннере. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `true` —  отображать кнопку закрытия. Значение по умолчанию.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `false` — не отображать кнопку закрытия. | 

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppShowBannerAdResult` и `VKWebAppShowBannerAdFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если баннерная реклама отобразилась,&#x0d;&#x0a;`false` — в ином случае. |
| `banner_width` | `integer` | Ширина баннера в пикселях. |
| `banner_height` | `integer` | Высота баннера в пикселях. |
| `banner_location` | `string` | Расположение баннера. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `top` — баннер будет прижат кверху.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `bottom` — баннер будет прижат книзу. Значение по умолчанию. |
| `layout_type` | `string` | Тип фона баннера. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `resize` — WebView станет меньше на размер баннера. Значение по умолчанию.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `overlay` — баннер отрисуется поверх WebView. Если нужно сдвинуть контент, разработчик мини-приложения делает это сам. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppShowBannerAdResult`

Сигнализирует, что баннерная реклама отобразилась. В обработчик события на стороне пользователя передаются следующие данные:

```JavaScript
{
  detail: {
    type: "VKWebAppShowBannerAdResult",
    data:{
      "result" : true,
      "banner_width": 100,
      "banner_height": 64,
      "banner_location": "top",
      "layout_type": "resize"
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppShowBannerAdFailed`

Информирует об ошибке, которая произошла при взаимодействии с платформой, или о том, что баннер не найден или уже показан.

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).


VK Bridge | Баннерная реклама| VKWebAppShowBannerAd

#  VKWebAppShowCommunityWidgetPreviewBox

`VKWebAppShowCommunityWidgetPreviewBox` показывает экран предпросмотра виджета для сообщества.

> Виджетам приложений сообществ посвящено [отдельное руководство](api/community-apps-widgets/getting-started). 

## Пример

```JavaScript
bridge.send('VKWebAppShowCommunityWidgetPreviewBox', {
  group_id: 166562603,
  type: 'text',
  code: 'return {
    "title": "Цитата",
    "text": "Текст цитаты"
  };'})
  .then((data) => { 
    if (data.result) {
      // Экран предпросмотра показан
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `group_id` &#x0d;&#x0a;*обязательное* | `integer` | Идентификатор сообщества. |
| `type` &#x0d;&#x0a;*обязательное* | `string` | Тип виджета. Возможные значения:&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `text` — выводит текст.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `list` — выводит список объектов с описанием и кнопками для действий.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `table` — выводит таблицу с данными.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `tiles` — выводит плитки с изображением и кратким описанием.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `compact_list` — выводит список элементов в компактном виде.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `cover_list` — выводит список изображений (от 1 до 3) с кнопкой для действия, заголовком и описанием.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `match` — выводит текущий результат спортивного матча.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `matches` — выводит список спортивных матчей.&#x0d;&#x0a; &nbsp;&nbsp; &bullet; `donation` — выводит прогресс пожертвований.&#x0d;&#x0a;&#x0d;&#x0a; Параметры всех поддерживаемых типов виджетов подробно описаны в разделе [Виджеты приложений сообществ](reference/objects/app-widget).|
| `code` &#x0d;&#x0a;*обязательное* | `string` | Код виджета на языке программрования VKScript.&#x0d;&#x0a;&#x0d;&#x0a; Подробная информация о синтаксисе и возможностях этого языка с примерами находится в описании метода [`execute`](method/execute#Пример%20значения%20параметра%20code). |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppShowCommunityWidgetPreviewBoxResult` и `VKWebAppShowCommunityWidgetPreviewBoxFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если экран предпросмотра показан. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех событий VK Bridge.

### События

#### `VKWebAppShowCommunityWidgetPreviewBoxResult`

Сигнализирует, что экран предпросмотра показан. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppShowCommunityWidgetPreviewBoxResult",
    data: {
      result: true
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppShowCommunityWidgetPreviewBoxFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).

## Песочница

[VKWebAppShowCommunityWidgetPreviewBox](https://vk.cc/bZfr2S) 


VK Bridge | Сообщества | VKWebAppShowCommunityWidgetPreviewBox

# VKWebAppShowImages

`VKWebAppShowImages` открывает нативный экран для просмотра изображений.

## Пример

```JavaScript
bridge.send('VKWebAppShowImages',{
  images: [
    'https://pp.userapi.com/c639229/v639229113/31b31/KLVUrSZwAM4.jpg',
    'https://pp.userapi.com/c639229/v639229113/31b94/mWQwkgDjav0.jpg',
    'https://pp.userapi.com/c639229/v639229113/31b3a/Lw2it6bdISc.jpg'
  ]
  })
  .then((data) => { 
    if (data.result) {
      // Нативный экран открыт
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });
```

## Платформы

Android, iOS, Mobile Web

## Параметры

| Поле | Тип | Описание |
| --- | --- | --- |
| `images` &#x0d;&#x0a;*обязательное* | `array[string]` | Массив строк, содержащих URL-адреса изображений. |
| `start_index` &#x0d;&#x0a;*необязательное* | `integer` | Индекс элемента массива `images`, с которого нужно начать отображение (положительное число, включая `0`). Индексация начинается с `0`. |

## Результат

Проверить результат можно:

* Используя объект [`Promise`](#Объект%20Promise), который возвращается вызовом `bridge.send(...)`.

* С помощью [событий](#События) `VKWebAppShowImagesResult` и `VKWebAppShowImagesFailed`.

[Подробнее о проверке результатов при вызовах VK Bridge](bridge/getting-started#Обработка%20результата).

### Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в `then`-обработчик объекта `Promise`. В качестве ответа платформа возвращает объект со следующим полем:

| Поле | Тип | Описание |
| --- | --- | --- |
| `result` | `boolean` | `true`, если нативный экран открыт. |

Если при обращении к платформе произошла ошибка, управление передаётся в метод `catch`. В качестве ответа платформа возвращает [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий  для всех событий VK Bridge.

### События

#### `VKWebAppShowImagesResult`

Сигнализирует, что нативный экран открыт. В обработчик события на стороне пользователя передаются следующие данные:  

```JavaScript
{
  detail: {
    type: "VKWebAppShowImagesResult",
    data: {
      result: true
    }
  }
}
```

Передаваемый объект подобен объекту, возвращаемому при [успешном выполнении промиса](#Объект%20Promise).

#### `VKWebAppShowImagesFailed`

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

В обработчик события на стороне пользователя передаётся [объект с информацией об ошибке](bridge/getting-started#Обработка%20ошибок%20VK%20Bridge), общий для всех методов VK Bridge.

#### Пример обработки событий

Смотрите раздел [Обработка событий-результатов](bridge/getting-started#Обработка%20результата).


VK Bridge | Общие события | VKWebAppShowImages

# VKWebAppShowInviteBox

`VKWebAppShowInviteBox` открывает окно приглашения друзей в игру.

## Пример

```JavaScript
bridge.send("VKWebAppShowInviteBox", {})
         .then(data => console.log(data.success))  
        .catch(error => console.log(error));
```

## Платформы

Android, iOS, Mobile Web, Web

## Параметры

—

## Результат

Если пользователь нажал &laquo;Пригласить&laquo; в диалоге, чтобы отправить приглашение, то в ответе на запрос вернется `"success": true`, например:

```JSON
{
  "type": "VKWebAppShowInviteBoxResult",
  "data": {
    "success": true,
    "notSentIds": []
  }
}
```

Поле `notSentIds` &mdash; массив. В нём будут перечислены идентификаторы пользователей, которым приглашение не было отправлено по каким-либо причинам.

Если пользователь отменит отправку в диалоге, то сгенерируется исключение и управление перейдёт в блок `catch` (cм. [пример](#Пример) выше).

## Особенности работы

Мини-приложения и игры, не добавленные в каталоги ВКонтакте, могут присылать приглашения только своим администраторам.

## Песочница

[VKWebAppShowInviteBox](https://vk.cc/bZfCRH)