# 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). 

Получить сервисный ключ доступа можно в [настройках вашего приложения](mini-apps/management/settings). Ключ не привязан к IP-адресу при использовании с открытыми методами, срок его действия не ограничен. Если ключ был скомпрометирован, вы можете сгенерировать новый ключ, при этом старый будет аннулирован.

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

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

*  Если вы разрабатываете приложение для 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` минуты после того, как произошло событие.

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

# Клавиатура

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

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

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

Если она включена, и у пользователя еще нет переписки с сообществом, мы показываем кнопку «Начать», которая отправляет команду `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) используемого языка.

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

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

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

В этом руководстве вы найдете базовую информацию о принципах работы 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 ВКонтакте | Товары | Товары ВКонтакте

# Client Credentials Flow для получения сервисного ключа доступа

Способ получения ключа доступа с помощью Client Credentials Flow устарел и больше не работает. [Подробности](reference/roadmap).

Для работы с API, в частности с методами [secure](method/secure), используйте [сервисный ключ доступа](mini-apps/management/settings) из настроек приложения.

Использование 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.com

# Правила для ботов

**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. Получить разрешение для повторного подключения он может через Поддержку, если произошла ошибка. Либо через полгода, согласно критериям отбора сообществ.

Правила | Правила для ботов

# 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

# 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

#  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

## Актуальные события

* [Грантовая программа Fresh Code 2022](community/events/fresh-code-2022)

## Прошедшие события

* [Код Петербурга — 2022](community/events/code-of-petersburg)
* [Mini Design Award — 2022](community/events/mini-design-award)

Сообщество

# Грантовая программа Fresh Code 2022 от VK Mini Apps

> Сроки проведения: с 7 октября по 2 декабря 2022 года.
> Подведение итогов: 5 декабря 2022 года.

Мы верим в технологии: видим, как удобные сервисы каждый день помогают миллионам пользователей ВКонтакте делать покупки, путешествовать, учиться, знакомиться. Поэтому развиваем платформу VK Mini Apps — вместе со всеми, кто хочет попробовать себя в разработке мини-приложений или уже создаёт их.

Если у вас есть идея или готовый проект, присоединяйтесь к грантовой программе VK Fresh Code. В этом году она длится два месяца: за это время новые мини-приложения найдут свою аудиторию, и уже в декабре создатели лучших 25 сервисов смогут получить гранты — по 180 000 рублей.

![](26b96330c778c2a0c6cabd5bf91c033e16900373954e0d9f7349f7c6 "1269910100372578947")

**Рассказываем по порядку:**

1. [Как присоединиться к программе и побороться за грант](#Как%20присоединиться%20к%20программе%20и%20побороться%20за%20грант) 
2. [Что даёт Fresh Code, помимо грантов](#Что%20даёт%20Fresh%20Code,%20помимо%20грантов)
3. [Почему мини-приложения в тренде](#Почему%20мини-приложения%20в%20тренде)

## Как присоединиться к программе и побороться за грант

### Шаг 1. Cоздайте оригинальное мини-приложение в тематиках программы

В грантовой программе VK Fresh Code 2022 десять тематик:

* Образ жизни
* Образование
* Мероприятия
* Транспорт
* Развлечения
* Путешествия
* Еда и напитки
* Красота и здоровье
* Бизнес
* Покупки

> Последний день приёма заявок – 2 декабря.
>
> Можно всё это время работать над одним проектом или успеть подготовить несколько мини-приложений в разных темах.

Мы прислушались к вашим пожеланиям и пересобрали конкурс. В этой статье вы найдёте традиционные условия и новинки программы. Например, теперь экспертное жюри будет оценивать приложения по нескольким новым критериям — постарайтесь учесть их уже при разработке или апгрейде своего проекта к конкурсу. Больше баллов получат проекты, которые:

* Точно соответствуют одной из тематик.
* Содержат оригинальную идею, которая ещё не встречалась на платформе VK Mini Apps.
* Классно продуманы в плане UX и UI — пользовательского опыта и интерфейса.
* Технически качественно реализованы, пролечены от багов, запускаются на вебе и мобильных платформах.
* Круто прошли питчинг — публичную защиту перед экспертами.
* Попали в каталог мини-приложений.

Полезные ресурсы при подготовке проекта:

* [Документация](mini-apps/getting-started) по разработке мини-приложений.
* [Библиотека VKUI](libraries/vkui) и [макеты Figma](https://www.figma.com/@vk).
* В [сообществе VK Mini Apps](https://vk.com/vkappsdev) вы найдёте много полезных материалов.
* На промежуточных питчингах и сессиях вопросов-ответов все участники смогут получить рекомендации от Команды ВКонтакте.
* Всё о процессе разработки мини-приложения от идеи до релиза вы найдёте в нашем [гайде на Хабре](https://habr.com/ru/company/vk/blog/521192/).

### Шаг 2. Опубликуйте мини-приложение ВКонтакте

Да, публикация мини-приложения в каталоге ВКонтакте не является обязательным условием участия в грантовом конкурсе VK Fresh Code 2022 и получения приза. Но для тех участников, кто всё же планирует получить дополнительные баллы за публикацию мини-приложения в каталоге, дадим пару советов. Стоит учесть, что прежде чем проект попадёт в каталог, он должен пройти [модерацию](mini-apps/catalog/getting-started) и тестирование командой [VK Testers](https://vk.com/testers). Здесь важно рассчитать время, чтобы уложиться в сроки программы: в среднем этот этап занимает около двух недель. Или больше, если в сервисе найдётся много багов.

> Отправить мини-приложение в тестирование лучше не позднее **18 ноября**. Так оно успеет пройти проверку, появиться в каталоге и сможет претендовать на баллы по этому критерию.

После публикации ваш сервис станет доступен всем пользователям ВКонтакте. Они смогут найти его на вкладке **Сервисы** в мобильном приложении, на [m.vk.com](https://m.vk.com) и в версии для компьютера, а также по ссылке [vk.com/services](https://vk.com/services).

> Для всех победителей конкурса, чьи мини-приложения окажутся в каталоге до&nbsp;**2&nbsp;декабря** включительно, мы подготовим специальное продвижение в рамках новогодних праздников. Это отличная возможность бодро набрать аудиторию для своих проектов.

### Шаг 3. Участвуйте в питчингах с экспертами

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

### Шаг 4. Подайте заявку на грант

Для этого до **23:59 2 декабря** нужно заполнить [форму](https://vk.com/app6013442_-166562603?form_id=33#form_id=33), которая также будет опубликована в [сообществе VK Mini Apps](https://vk.com/vkappsdev). Обязательно укажите в ней ссылку на готовое приложение.

Подать заявку на грант могут только физические лица — авторы мини-приложений, которым уже исполнилось 14 лет. При этом неважно, создан проект независимым разработчиком, командой энтузиастов или с поддержкой бизнеса.

### Шаг 5. Дождитесь итогов

Результаты объявим **5 декабря**. Эксперты выберут 25 лучших мини-приложений, авторы которых получат денежные призы — по 180 000 рублей.

## Что даёт Fresh Code, помимо грантов

* **Новые идеи и механики для ваших проектов**

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

* **Опыт питчингов и обратную связь от экспертов**

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

## Почему мини-приложения в тренде

Потому что это удобно: сервисы открываются внутри ВКонтакте и не забивают память телефона, а в каталоге можно найти инструменты на любой случай — купить билеты, записаться на стрижку, проверить курс валют. Поэтому и пользуются мини-приложениями всё чаще: **ежемесячная аудитория VK Mini Apps — более 45 миллионов человек**.

При этом платформа VK Mini Apps продолжает расширяться: к октябрю на ней уже более **50 000 мини-приложений**. Всё потому, что здесь рады разработчикам: документация и обучающие материалы в открытом доступе, образовательные и грантовые программы стали традицией. А в [сообществе](https://vk.com/vkappsdev) легко найти единомышленников, посоветоваться, собрать команду — словом, есть всё, чтобы вместе запускать проекты, которых ждут пользователи.

Fresh Code от VK Mini Apps меняется вместе с платформой: становится динамичнее и предлагает больше. В 2022 году это не только программа, где можно получить знания, создать своё мини-приложение и выиграть грант. Это шанс сделать крутой сервис для миллионов пользователей.
С вопросами о программе пишите в сообщество VK Mini Apps: [vk.me/vkappsdev](https://vk.me/vkappsdev).
Ждём ваши заявки — мы будем рядом на всех этапах. ВКонтакте.

> Актуальной информацией о конкурсе будем делиться в первую очередь в специальном [чате для участников](https://vk.cc/chUkvy), там же можно обсудить, какие технологии стоит интегрировать в свои проекты, и задать интересующие вопросы команде ВКонтакте. Присоединяйтесь: [vk.cc/chUkvy](https://vk.cc/chUkvy)

## Положение о конкурсе

* [Публичное положение об участии в конкурсе](community/events/fresh-code-2022-regulations) 


Сообщество | События | Грантовая программа Fresh Code 2022 от VK Mini Apps

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

## Создание приложений

### [Мини-приложения](mini-apps/overview)
Создавайте полезные сервисы на каждый день с помощью кросс-платформенных приложений на базе веб-технологий: HTML, JavaScript, CSS.

### [Игры](games/overview)
Увлекайте миллионы игроков своими идеями. Ни паролей, ни скачиваний — игры мгновенно запускаются прямо из интерфейса ВКонтакте. 

### [VK Bridge](bridge/overview)
Используйте API ВКонтакте и API операционной системы, установленной на устройстве пользователя, с помощью одной библиотеки.

### [Маруся](marusia/getting-started)
Создавайте голосовой интерфейс своего продукта с помощью Маруси.

## Бизнес-инструменты

### [VK Pay](pay/getting-started)
Принимайте оплату за товары и услуги — прямо в чатах, сообществах и мини-приложениях, с баланса VK Pay или привязанных к нему карт.

### [VK Donut](api/donut/getting-started)
Управляйте платной подпиской и разнообразными программами лояльности в сообществе.

### [Рекламный API](api/ads/getting-started)
Автоматически запускайте объявления и целые рекламные кампании, обновляйте аудитории ретаргетинга и получайте статистику.

## Интеграция контента

### [Виджеты для сайтов](widgets/overview)
Предоставьте посетителям сайта возможность авторизовываться через ВКонтакте, добавлять комментарии и плейлисты, общаться в сообщениях.

### [Публикации ВКонтакте](api/posts)
Предложите пользователям делиться ВКонтакте статьями или комментариями с вашего сайта или из приложения.

### [Маски](masks/overview)
Создавайте маски — развивайте персональный бренд, заявляйте о себе и привлекайте подписчиков на личную страницу или в сообщество.

### [Чат-боты](api/bots/getting-started)
Автоматизируйте рутинные и похожие задачи с помощью чат-бота ВКонтакте.

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

Account

AppWidgets

Apps

Auth

Board

Calls

Database

Docs

Donut

DownloadedGames

Fave

Friends

Gifts

Groups

LeadForms

Likes

Market

Messages

Newsfeed

Notes

Notifications

Orders

Pages

Photos

Places

Podcasts

Polls

PrettyCards

Search

Secure

Stats

Status

Storage

Store

Stories

Streaming

Users

Utils

Video

Wall

Widgets

Описание методов API

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

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

user_id

После успешного выполнения возвращает битовую маску настроек текущего пользователя в данном приложении. 

### Пример

Если Вы хотите получить права на **Доступ к друзьям** и **Доступ к статусам пользователя**, то Ваша битовая маска будет равна: `2 + 1024 = 1026`. 

Если, имея битовую маску `1026`, Вы хотите проверить, имеет ли она доступ к друзьям — Вы можете сделать `1026 & 2`. Например: `alert(1026 & 2);`

См. [Список возможных настроек прав доступа](reference/access-rights).

account.getAppPermissions

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

Cчетчики, информацию о которых нужно вернуть. Может включать следующие значения:
* `friends` — новые заявки в друзья;
* `friends_suggestions` — предлагаемые друзья;
* `messages` — новые сообщения;
* `photos` — новые отметки на фотографиях;
* `videos` — новые отметки на видеозаписях;
* `gifts` — подарки;
* `events` — события;
* `groups` — сообщества;
* `notifications` — ответы;
* `sdk` — запросы в мобильных играх;
* `app_requests` — уведомления от приложений.
* `friends_recommendations` — рекомендации друзей.

filter

Возвращает объект, который может содержать поля `friends`, `messages`, `photos`, `videos`, `notes`, `gifts`, `events`, `groups`, `notifications`, `sdk`, `app_requests`, `friends_recommendations` со значением счетчиков (`integer`).




account.getCounters

Возвращает информацию о текущем профиле.

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

`first_name`
`string`
Имя пользователя. 
 
`last_name`
`string`
Фамилия пользователя.

`maiden_name`
`string`
Девичья фамилия пользователя (только для женского пола).

`screen_name`
`string`
Короткое имя пользователя (если есть).

`sex`
`integer`
Пол. Возможные значения:
*  `1` — женский,
*  `2` — мужской,
*  `0` — пол не указан.

`relation`
`integer`
Семейное положение. Возможные значения:
*  `1` — не женат/не замужем,
*  `2` — есть друг/есть подруга,
*  `3` — помолвлен/помолвлена,
*  `4` — женат/замужем,
*  `5` — всё сложно,
*  `6` — в активном поиске,
*  `7` — влюблён/влюблена,
*  `8` — в гражданском браке,
*  `0` — не указано.

`relation_partner`
`object`
Объект [пользователя](reference/objects/user), с которым связано семейное положение (если есть).

`relation_pending`
`integer`
Передается `1`, если пользователь, указанный в `relation_partner`, не подтвердил отношения.

`relation_requests`
`array`
Список объектов [пользователей](reference/objects/user), которые указали, что состоят в отношениях с данным пользователем (если есть).

`bdate`
`string`
Дата рождения пользователя, возвращается в формате D.M.YYYY.

`bdate_visibility`
`integer`
Видимость даты рождения. Возможные значения: 
*  `1` — показывать дату рождения,
*  `2` — показывать только месяц и день,
*  `0` — не показывать дату рождения.

`home_town`
`string`
Название родного города.

`country`
`object`
Страна. Объект, содержащий поля:
*  `id` (`integer`) — идентификатор страны,
*  `title` (`string`) — название страны.

`city`
`object`
Город. Объект, содержащий поля:
*  `id` (`integer`) — идентификатор города,
*  `title` (`string`) — название города.

`name_request`
`object`
Информация о заявке на смену имени, если она была подана. Объект, содержащий поля:
*  `id` (`integer`) – идентификатор заявки, необходимый для её отмены (только если `status` равен `processing`).
*  `status` (`string`) – статус заявки. Возможные значения:
    *  `processing` – заявка рассматривается,
    *  `declined` – заявка отклонена,
    *  `response` – общий ответ по статусу обработки заявки,
    *  `response_with_link` – общий ответ по статусу обработки заявки, содержащий ссылку в поле `link`.
*  `first_name` (`string`) – имя пользователя, указанное в заявке,
*  `last_name` (`string`) – фамилия пользователя, указанная в заявке.

`status`
`string`
Статус пользователя.

`phone`
`string`
Номер телефона.

account.getProfileInfo

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

Permission denied. You have requested too many actions this day. Try later.

Идентификаторы музыкантов. 

Возвращает массив музыкантов с соответствующими идентификаторами из запроса.

`id`
`integer` 
Идентификатор музыканта. 

`name` 
`string` 
Полный псевдоним музыканта. 
 
`avatar` 
`string` 
Аватарка музыканта. 

ads.getMusiciansByIds

Позволяет получить коллекцию изображений, загруженных для приложения, в [виджетах приложений сообществ](api/community-apps-widgets/getting-started).

* `offset` (`integer`) — смещение для получения определённого подмножества результатов.
* `count` (`integer`) — максимальное число результатов для получения.
* `image_type` (`string`) — тип изображения. Возможные значения:
   * `160x160`,
   * `160x240`,
   * `24x24`,
   * `510x128`,
   * `50x50`.

Возвращает общее число результатов в поле `count` (`integer`) и массив объектов, описывающих изображения, в поле `items` (`array`).

Каждый объект массива  `items` содержит следующие поля:
* `id` (`string`) — идентификатор изображения. Обратите внимание, идентификаторы изображений для виджетов отличаются от обычных фотографий, и не представляют собой сочетание `owner_id+"_"+photo_id`. Полученный идентификатор нужно использовать в коде виджета «как есть».
* `type` (`string`) — тип изображения. Возможные значения:
   * `160x160`,
   * `160x240`,
   * `24x24`,
   * `510x128`,
   * `50x50`.
* `images ` (`array`) — массив копий изображения. Каждый объект в массиве содержит следующие поля:
   * `url` (`string`) — URL копии;
   * `width` (`integer`) — ширина в px;
   * `height` (`integer`) — высота в px.

appWidgets.getAppImages

Сохраняет аудиозаписи после успешной [загрузки](api/upload#Загрузка%20аудиозаписей).

The audio file was removed by the copyright holder and cannot be reuploaded.

Параметр, возвращаемый в результате [загрузки аудиофайла на сервер](api/upload#Загрузка%20аудиозаписей).

server

audio

hash

Автор композиции. По умолчанию берётся из ID3 тегов.

artist

Название композиции. По умолчанию берётся из ID3 тегов.

title

Возвращает массив объект загруженной аудиозаписи с полями:
* `id`,
* `owner_id`,
* `artist`,
* `title`,
* `url`.

audio.save

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

Открывает ранее закрытую тему (в ней станет возможно оставлять новые сообщения).

board.openTopic

идентификатор сообщества, в котором размещено обсуждение.

group_id

идентификатор обсуждения.

topic_id

После успешного выполнения возвращает `1`.

board.closeTopic

Возвращает список сообщений в указанной теме.

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

Идентификатор обсуждения.

`1` — будет возвращено дополнительное поле `likes`. По умолчанию поле `likes` не возвращается.

need_likes

Идентификатор комментария, начиная с которого нужно вернуть список (подробности см. ниже).

start_comment_id

Смещение, необходимое для выборки определенного подмножества сообщений.

offset

Количество сообщений, которое необходимо получить (но не более **100**). По умолчанию — **20**.

count

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

extended

Порядок сортировки комментариев:
* `asc` — хронологический;
* `desc` — антихронологический.

sort

Если был передан параметр `start_comment_id`, будет найдена позиция комментария в списке (или ближайший к нему более ранний). Начиная с этой позиции будет возвращено `count` комментариев. Смещение `offset` в этом случае будет отсчитываться от этой позиции (оно может быть отрицательным).

В случае успеха возвращает объект, содержащий поле `items`, поле `poll`, если к теме прикреплен опрос, а также поле `profiles` (если был указан параметр `extended`). 

Поле `items` представляет собой массив, содержащий [объекты, описывающие комментарии](reference/objects/comment-topic).


Если к теме был прикреплен опрос, возвращается поле `poll` следующего вида:
* `owner_id` — идентификатор владельца опроса;
* `poll_id` — идентификатор опроса;
* `created` — время создания опроса в формате `unixtime`;
* `is_closed` — `1`, если опрос закрыт (в нем больше нельзя принимать участие) или `0` в противном случае;
* `question` — текст вопроса для опроса;
* `votes` — общее количество ответивших пользователей;
* `answer_id` — идентификатор ответа текущего пользователя (если текущий пользователь еще не отвечал в данном опросе, то содержит `0`);
* `answers` — массив, содержащий объекты с вариантами ответа на вопрос в опросе:
   * `id` — идентификатор ответа на вопрос;
   * `text` — текст ответа на вопрос;
   * `votes` — количество пользователей, проголосовавших за данный вариант ответа;
   * `rate` — рейтинг данного варианта ответа, выраженный в процентах.

В случае передачи параметра `extended` равным `1`, поле `profiles` содержит массив объектов [`user`](reference/objects/user) с информацией о данных пользователей, являющихся авторами сообщений. 

Если был передан параметр `start_comment_id`, будет также возвращено поле `real_offset` – итоговое смещение данного подмножества комментариев (оно может быть отрицательным, если был указан отрицательный `offset`).

board.getComments

Возвращает список городов.

Идентификатор страны, полученный [`database.getCountries`](method/database.getCountries).

country_id

Идентификатор региона, города которого необходимо получить.

region_id

Строка поискового запроса. Например, `«Санкт»`.
Максимальная длина строки — 15 символов.

`1` – возвращать все города.
`0` – возвращать только основные города.

need_all

Отступ, необходимый для получения определенного подмножества городов.

Количество городов, которые необходимо вернуть.

После успешного выполнения возвращает объект, содержащий число результатов в поле `count` и массив объектов, описывающих города, в поле `items`.

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

`id`
`integer`
Идентификатор города. 

`title`
`string`
Название города.

Объект может содержать дополнительные поля:

`area`
`string`
Область. 

`region` 
`string`
Регион. 

Если не задан параметр `q`, то будет возвращён список самых крупных городов в заданной стране. Если задан параметр `q`, то будет возвращён список городов, которые релевантны поисковому запросу. Полем `important` отмечены ключевые города для текущего пользователя.

database.getCities

Возвращает адрес сервера для [загрузки документов](https://dev.vk.com/api/upload#%D0%97%D0%B0%D0%B3%D1%80%D1%83%D0%B7%D0%BA%D0%B0%20%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%BE%D0%B2).

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

Возвращает объект с полем `upload_url`, содержащим адрес для загрузки файла. После успешной загрузки документа необходимо воспользоваться методом [`docs.save`](method/docs.save).

docs.getUploadServer

Сохраняет документ после его успешной [загрузки](api/upload) на сервер.

Параметр, возвращаемый в результате [загрузки файла](api/upload) на сервер.

file

return_tags

После успешного выполнения возвращает массив объектов, описывающих загруженные документы. Каждый объект массива содержит поле `type` (`string`) с возможными значениями `audio_message`, `doc`, и одноименный объект, описывающий загруженный документ.

Для `type` = `audio_message` объект `audio_message`, описывающий [голосовое сообщение](reference/objects/audio-message).
Для `type` = `doc` объект `doc`, описывающий другие типы [документов](reference/objects/doc).

docs.save

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

Появились  методы для работы с VK Donut:
[donut.isDon](donut.isDon)
[donut.getFriends](donut.getFriends)
[donut.getSubscription](donut.getSubscription)
[donut.getSubscriptions](donut.getSubscriptions)

В объекте [записи](reference/objects/post) появилась информация о VK Donut.
В объекте [комментария](reference/objects/comment) появилась информация о VK Donut.



5.125

Идентификатор сообщества.

> Обратите внимание, идентификатор сообщества в параметре `owner_id` необходимо указывать со знаком `«-»` — например, `owner_id`=`-1` соответствует идентификатору сообщества [ВКонтакте API](https://vk.com/apiclub) (club1).

owner_id

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

donut.isDon

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

Код алгоритма в VKScript-формате, похожем на JavaSсript или ActionScript (предполагается совместимость с ECMAScript). Алгоритм должен завершаться командой `return %выражение%`. Операторы должны быть разделены точкой с запятой.

> Внутри `code` может содержаться не более 25 обращений к методам API.

code

func_v

### Пример значения параметра `code`

```VKScript
// Присваивает переменной a результат поиска по фотографиям с данными параметрами. 
var a = API.photos.search({"q":"Nature","count":3});

// Присваивает переменной b список владельцев найденных фотографий.
var b = a.items@.owner_id;

// Присваивает переменной с данные о страницах владельцев из списка b. 
var c = API.users.get({"user_ids":b});

// Возвращает список фамилий из данных о владельцах.
return c@.last_name;

// Пример цикла.
var a = 1; 
var b = 10; 
while (b != 0) { 
    b = b - 1; 
    a = a + 1; 
}; 
return a;
```

То же самое можно более коротко записать так:

```VKScript
return API.users.get({"user_ids": API.photos.search({"q":"Beatles", "count":3}).items@.owner_id})@.last_name;
```

Поддерживаются:
* арифметические операции,
* логические операции,
* создание массивов и списков ([X,Y]),
* `parseInt` и `parseDouble`,
* конкатенация (`+`),
* конструкция `if`,
* фильтр массива по параметру (`@.`),
* вызовы методов API, параметр `length`,
* циклы, используя оператор `while`,
* методы Javascript: `slice`, `push`, `pop`, `shift`, `unshift`, `splice`, `substr`, `split`,
* оператор `delete`,
* присваивания элементам маcсива, например: `row.user.action = "test"`,
* поиск в массиве или строке — `indexOf`, например: `"123".indexOf(2) = 1, [[1, 2, 3]].indexOf(3) = 2`. Возвращает `-1`, если элемент не найден.

В данный момент не поддерживается создание функций. 

Обращение к элементам массива с результатом какого-либо метода всего должно основываться на структуре JSON, а не XML. Например, правильным обращением является:

```VKScript
API.photos.search({"q":"Nature","count":3}).items@.owner_id;
```

А не:

```VKScript
API.photos.search({"q":"Nature","count":3}).items@.photo@.owner_id;
```

 Метод `execute` также может использоваться и для получения результатов нескольких не связанных между собой запросов.

**Пример значений параметра `code`**

```VKScript
return [API.friends.get(), API.status.get()];
return {"friends": API.friends.get(), "status": API.status.get()};
```

 В методе `execute` поддерживаются логические операции `<` (меньше), `>` (больше), `<=` (меньше или равно), `>=` (больше или равно), `==` (равно) и `!=` (не равно). В данный момент поддерживаются сравнения двух строк, двух чисел и строки и числа (в этом случае строка приводится к числу).

 Результат логического выражения может быть использован в управляющей конструкции `if...[[else...]]`:

**Пример значения параметра `code`**

```VKScript
var posts = API.wall.get({"count": 1});
 
if (posts.count<0) {
  return {"post": null, "copy_owner": null};
} else {
  var post = posts.items[0];
  var copy_owner=null;
  if (post.copy_history[0]){
    if (post.copy_history[0].owner_id > 0) {
      copy_owner = API.users.get({"user_id": post.copy_history[0].owner_id})[0];
    } else
    if (post.copy_history[0].owner_id  < 0) {
      copy_owner = API.groups.getById({"group_ids": -post.copy_history[0].owner_id})[0];
    }
    return {"post": post, "copy_owner": copy_owner};
  } else {
    return {"post": post, "copy_owner": null};
  }
}
```


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

Обратите внимание: версия API, указанная при вызове `execute`, не применяется автоматически к методам, вызываемым внутри `code`.

> **Обратите внимание!** 
> Существует ограничение на объём ответа. В случае, если данные в ответе занимают больше 5 МБ, вернётся ошибка 13 с комментарием `"response size is too big"`.


execute

Методы для работы с друзьями.

friends

Возвращает список идентификаторов друзей пользователя или расширенную информацию о друзьях пользователя (при использовании параметра `fields`).

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

Порядок, в котором нужно вернуть список друзей. Допустимые значения:
* `hints` — сортировать по рейтингу, аналогично тому, как друзья сортируются в разделе **Мои друзья**.
> Это значение доступно только для Standalone-приложений с ключом доступа, полученным по схеме Implicit Flow.
* `random` — возвращает друзей в случайном порядке.
* `name` — сортировать по имени. Данный тип сортировки работает медленно, так как сервер будет получать всех друзей а не только указанное количество `count`. (работает только при переданном параметре `fields`).

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

order

Идентификатор списка друзей, полученный методом [`friends.getLists`](method/friends.getLists), друзей из которого необходимо получить. Данный параметр учитывается, только когда параметр `user_id` равен идентификатору текущего пользователя.

> Этот параметр доступен только для Standalone-приложений с ключом доступа, полученным по схеме Implicit Flow.

list_id

Количество друзей, которое нужно вернуть.

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

Список дополнительных полей, которые необходимо вернуть.

Доступные значения:
* `bdate`;
* `can_post`;
* `can_see_all_posts`;
* `can_write_private_message`;
* `city`;
* `contacts`;
* `country`;
* `domain`;
* `education`;
* `has_mobile`;
* `timezone`;
* `last_seen`;
* `nickname`;
* `online`;
* `photo_100`;
* `photo_200_orig`;
* `photo_50`;
* `relation`;
* `sex`;
* `status`;
* `universities`.

fields

Падеж для склонения имени и фамилии пользователя. 
Возможные значения: 
* именительный – `nom`;
* родительный – `gen`;
* дательный – `dat`;
* винительный – `acc`; 
* творительный – `ins`; 
* предложный – `abl`.
По умолчанию `nom`.

name_case

После успешного выполнения возвращает список идентификаторов (`id`) друзей пользователя, если параметр `fields` не использовался. 
При использовании параметра `fields`  возвращает список объектов [пользователей](reference/objects/user), но не более 5000.

friends.get

Методы для работы с сообществами.

groups

Позволяет редактировать ссылки в сообществе.

Позволяет добавлять ссылки в сообщество.

5.58