Documentation: VK App Widget for Joomla
System Requirements
System requirements differ for Joomla 3, Joomla 4, Joomla 5 and Joomla 6, so please refer to the section corresponding to your version.
Joomla 3
Joomla 4
Joomla 5 and Joomla 6
Extension Installation
The extension installation process is slightly different for Joomla 3 and Joomla 4/5/6, so please refer to the section corresponding to your version.
Installation for Joomla 3
- Download the extension package.
- Go to the Joomla 3 administration panel.
- Open "Extensions" -> "Extension Manager".
- Click on the "Upload Package" tab.
- Select the downloaded extension package and click "Upload and Install".
Installation for Joomla 4, Joomla 5, and Joomla 6
- Download the extension package.
- Go to the Joomla 4/5/6 administration panel.
- Open "System" -> "Extensions".
- Click on the "Upload Package" tab.
- Drag and drop the downloaded extension package into the upload area or click "Select Package".
- Click "Upload and Install".
Extension settings
Module settings are located in different places depending on the Joomla version. Please use the paths below to find the module:
- Joomla 3: "Extensions" -> "Modules"
- Joomla 4/5/6: "Content" -> "Site Modules"
In the module list, find "IWS.BY VK App Widget". Click on the module name, and a page with available settings will open. Let's review each field below.
License Key
Enter the license key received when purchasing the module on the IWS.BY website. Without a key in this field, the module will not be able to access the update server and update automatically.
Connect Open API
If "Yes" is selected, the VK API will be connected to the site. If the VK API is already connected to your site via the link https://vk.com/js/api/openapi.js?169, select "No". Without the connected VK API, the widget will not work.
App ID
You need to enter the numeric ID of the application in the VK social network, the information of which you want to display in the widget. How to find the application ID is described on the page above, in the "Getting the VK App ID" section.
Site ID
You need to enter the ID of your website, which is created in the dashboard at the link https://dev.vk.ru/ru/mini-apps/management/creating-new-apps. Read more in the "Changes in VK Open API" section of the documentation below.
Widget Type
The option is responsible for the application widget type. There are three options for displaying information: card, member list, and button. Card — the widget will show the application logo, name, category, number of members, and the "Play" button. Member list — the widget will show the application logo, name, category, number of members, member avatars, and the "Play" button. Button — the widget will show the "Play" button.
Width
The field is responsible for the width of the widget with the application. It is specified as a number in pixels. This field is available if the "Member list" value is selected in the "View" option.
Button Height
The option is responsible for the button height in pixels. You can only select a value, you cannot enter your own. This field is available if the "Button" value is selected in the "View" option.
Getting the VK App ID
To make the module work, you need to get the application ID in the VK social network.
Go to the "Games" section in the VK social network. Using the search, find the application or game you need.
Click on the image of the found application. An information window with the application will open. Pay attention to the address bar of the opened page. It will contain the application ID in the social network.
The number 5327745 is the unique numeric ID of the VK application. Remember or save it, it is necessary for configuring the module.
Changes in VK Open API
On September 7, 2026, VK introduced mandatory registration of a website that uses the public API. To continue using free widgets, you need to register the website address. More details at the link https://dev.vk.ru/ru/api/open-api/getting-started in the "Getting Started" section. You need to register the website as an application with the type "Website" or "Standalone application" at the link https://dev.vk.ru/ru/mini-apps/management/creating-new-apps. After registration, your website will be assigned a unique ID. It must be used on the website so that the widgets continue to work. The module has a "Site ID" field, which needs to be filled with the one received during registration. Attention! If a site ID is already used on the website, it is recommended to leave the "Site ID" field empty.
Extension update error
If you encounter an error when updating an extension in the Joomla control panel, this section of the instructions is for you.
Error appears in several cases, all of which are related to the extension's license key.
1) You have not filled in the license key in the extension settings.
Go to the extension settings and check if the "License key" field is filled in. Without a license key, it is not possible to download updates. Sometimes, you may have added a license key, but the Joomla CMS did not save it correctly. In this case, in the extension settings, after entering the license key, click "Save" and then click "Save & Close".
2) Your license key has expired.
To check the expiration date of your license key, go to https://iws.by/en/my-account/view-license-keys. In the list of license keys, find the key for your extension and check its validity in the "Valid until" column. If the license key has expired, it is not possible to get updates. To resolve this issue, place a new order and obtain a current license key.
3) The license key is not valid on your current site.
Our update system is designed so that the first time you access the update server, the license key is assigned to the site that requested it. If you try to use the license key on multiple sites, updates will be available for only one site. If you need updates for multiple sites, purchase multiple license keys on our website. Sites without license keys will not be able to receive updates.
Attention! If you have changed your site's address and cannot download updates, write to us at support@iws.by with the new site address. We will update the data on our update server, and within 24 hours you will be able to receive updates.
Support
IWS.BY support service for questions regarding our products is available via email: support@iws.by.
All available support options are available on the Support page: Go to.