> For the complete documentation index, see [llms.txt](https://neurosell.gitbook.io/parallelix/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://neurosell.gitbook.io/parallelix/api-reference/vk-bridge-mini-apps.md).

# VK Bridge (Mini Apps)

<figure><img src="/files/fm7g7bYepEIX8cKxknnc" alt=""><figcaption></figcaption></figure>

### What is VK Mini Apps (VK Bridge)

**VK Mini Apps** is an open platform of embeddable cross-platform applications that extend the capabilities of the VKontakte website and app. We call such applications mini-apps.

**VK Mini Apps** relies on a universal approach and uses standard web technologies: HTML, JavaScript, CSS to develop mini-apps.

[**You can learn more here**](https://vk.com/mini-apps).

***

### VK Bridge Platform Module (ParallelixVK)

{% hint style="warning" %}
**Module Name:** "vk"
{% endhint %}

Any of our modules **inherits from** [ParallelixWrapper](/parallelix/api-reference/general-client.md#parallelixwrapper-class) - a virtual class describing a **unified SDK structure**.\
Below we have described the peculiarities of working with the module, as well as the differences and description of API parameters for the current module.

#### PlatformSpecificParameters

**These are parameters** that are passed inside some module methods. When working with them, you need to **create subobjects** as [described in the documentation on working with such parameters](/parallelix/api-reference/general-client.md#platformspecificparameters).\
Inside this subobject are the parameters described in the documentation of a particular platform.

**Below we have described each method available for calling, its parameters with a reference to the official documentation and the name of the official method.**

***

### **Platform Specific configuration**

No specific configuration provided for this platform

### **API Reference**

| Method             | Official Method Link                                                                                                 | Parameters / Callbacks Data                                                                                                     |
| ------------------ | -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| GetLaunchParams    | [VKWebAppGetLaunchParams](https://dev.vk.com/en/bridge/VKWebAppGetLaunchParams)                                      | From official documentation (structure and naming)                                                                              |
| HandleEvents       | All events passed from VK Bridge library. See [example of events](https://dev.vk.com/en/bridge/VKWebAppInit#Events). | From official documentation (structure and naming)                                                                              |
| GetClientInfo      | [VKWebAppGetClientVersion](https://dev.vk.com/en/bridge/VKWebAppGetClientVersion)                                    | From official documentation (structure and naming)                                                                              |
| AddToHomeScreen    | [VKWebAppAddToHomeScreen](https://dev.vk.com/en/bridge/VKWebAppAddToHomeScreen)                                      | <p><strong>Not implemented on PC version of VK Mini Apps!</strong></p><p>From official documentation (structure and naming)</p> |
| OpenPaymentForm    | [KWebAppOpenPaymentForm](https://dev.vk.com/en/pay/payment-form/payment-form-for-developers/payment-create)          | From official documentation (structure and naming)                                                                              |
| CallCustomMethod   | Call any method from VK Bridge with our without parameters (for Example VKWebAppAddToHomeScreen)                     | From official documentation (structure and naming)                                                                              |
| AddToFavorites     | [VKWebAppAddToFavorites](https://dev.vk.com/en/bridge/VKWebAppAddToFavorites)                                        | From official documentation (structure and naming)                                                                              |
| ShareApplication   | [VKWebAppAddToFavorites](https://dev.vk.com/en/bridge/VKWebAppAddToFavorites)                                        | From official documentation (structure and naming)                                                                              |
| PublishStory       | [VKWebAppShowStoryBox](https://dev.vk.com/en/bridge/VKWebAppShowStoryBox)                                            | From official documentation (structure and naming) + mediaURL for uploading in story                                            |
| OpenLink           | -                                                                                                                    | Open link in new window (browser) with URL \[string] parameter                                                                  |
| AllowNotifications | [VKWebAppAllowNotifications](https://dev.vk.com/en/bridge/VKWebAppAllowNotifications)                                | From official documentation (structure and naming)                                                                              |
| GetStorage         | [VKWebAppStorageGetKeys](https://dev.vk.com/en/bridge/VKWebAppStorageGetKeys)                                        | From official documentation (structure and naming)                                                                              |
| SetStorage         | [VKWebAppStorageSet](https://dev.vk.com/en/bridge/VKWebAppStorageSet)                                                | From official documentation (structure and naming)                                                                              |
| CloseApplication   | [VKWebAppClose](https://dev.vk.com/en/bridge/VKWebAppClose)                                                          | From official documentation (structure and naming)                                                                              |
| ShowQRReader       | [VKWebAppOpenCodeReader](https://dev.vk.com/en/bridge/VKWebAppOpenCodeReader)                                        | From official documentation (structure and naming)                                                                              |
| RequestUserPhone   | [VKWebAppGetPhoneNumber](https://dev.vk.com/en/bridge/VKWebAppGetPhoneNumber)                                        | From official documentation (structure and naming)                                                                              |
| RequestUserEmail   | [VKWebAppGetEmail](https://dev.vk.com/en/bridge/VKWebAppGetEmail)                                                    | From official documentation (structure and naming)                                                                              |
| GetUserInfo        | [VKWebAppGetUserInfo](https://dev.vk.com/en/bridge/VKWebAppGetUserInfo)                                              | From official documentation (structure and naming)                                                                              |
| RequestLocation    | [VKWebAppGetGeodata](https://dev.vk.com/en/bridge/VKWebAppGetGeodata)                                                | From official documentation (structure and naming)                                                                              |
| RequestAuthToken   | [VKWebAppGetAuthToken](https://dev.vk.com/en/bridge/VKWebAppGetAuthToken)                                            | From official documentation (structure and naming)                                                                              |
| CallAPI            | [VKWebAppCallAPIMethod](https://dev.vk.com/en/bridge/VKWebAppCallAPIMethod)                                          | From official documentation (structure and naming)                                                                              |
| GoBack             | -                                                                                                                    | Go to previous page / hash or close application                                                                                 |

***

### Call directly methods from VK Bridge

To query methods directly, using the same syntax as in the official documentation, **use the following approach**:

```javascript
// Parallelix Direct Calls
client.Platform.Invoker.[YOUR_METHOD]

// Equivalient of
vkBridge.[FIELD_OR_METHOD]
```