Home » Documentation » Joomla » Modules » Documentation: VK App Widget for Joomla from iws.by

Documentation: VK App Widget for Joomla from iws.by

Documentation update date: 28.09.2025
Documentation is relevant for version: 1.2.4
Contents

Compatibility

  • Joomla 3.x
  • Joomla 4.x
  • Joomla 5.x
  • Joomla 6.x

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: 3.0.0 - 3.10.x.
  • PHP: 5.3 and above.
  • MySQL: 5.1 and above.
  • MariaDB: 10.1 and above.
  • PostgreSQL: 8.3.18 and above.
  • Virtual memory: 128Мб and above.
Joomla 4
  • Joomla: 4.0.0 - 4.x.x.
  • PHP: 7.2 and above.
  • MySQL: 5.6 and above.
  • MariaDB: 10.3.35 and above.
  • PostgreSQL: 11.0 and above.
  • Virtual memory: 128Мб and above.
Joomla 5 and Joomla 6
  • Joomla: 5.0.0 - 5.x.x. / 6.0.0 - 6.x.x.
  • PHP: 8.1 and above.
  • MySQL: 8.0.11 and above.
  • MariaDB: 10.4 and above.
  • PostgreSQL: 12.0 and above.
  • Virtual memory: 128Мб and above.

Installing the module

The module 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
  1. Download the module package.
  2. Go to the Joomla 3 administration panel.
  3. Open “Extensions” -> “Extension Manager”.
  4. Click on the “Upload Package” tab.
  5. Select the downloaded module package and click “Upload and Install”.
Installation for Joomla 4, Joomla 5, and Joomla 6
  1. Download the module package.
  2. Go to the Joomla 3 administration panel 4/5/6.
  3. Open “System” -> “Extensions”.
  4. Click on the “Upload Package” tab.
  5. Drag and drop the downloaded module package into the download area or click “Select Package”.
  6. Click “Upload and Install”.

Obtaining a VK application identifier

For the module to work, you need to get the identifier of the application in the social network VK.

Go to the “Games” section of the VK social network. Using the search, find the application or game you need.

Click on the picture 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 identifier of the application in the social network.

Application ID on the VK social network

The number 5327745 is the unique numeric identifier of the VK application. Memorize it or save it, it is needed to configure the module.

Configuring the module

The module settings are located in different places depending on the Joomla version. Please use the paths below to find the module:

  • Joomla 3: “Extensions” -> “Module Manager”
  • Joomla 4/5/6: “Content” -> “Site modules”

In the list of modules, find “IWS.BY VK App Widget“. Click on the name of the module and you will see a page with the available settings. Consider each field below.

License key

Type: Text field

Description: Enter the license key obtained when purchasing the module on the IWS.BY website. Without the key in this field, the module will not be able to access the update server and update automatically.

Example: IWSBY-111-111-111

Connect Open API

Type: Segmented buttons

Description: If Yes is selected, the API of the VK social network will be connected to the site. If the VK API is connected to your site by https://vk.com/js/api/openapi.js?169, select the value “No”. Without connected VK API the widget will not work.

Possible values:

  • Yes
  • No

Default: Yes

Application ID

Type: Numeric field

Description: In the field, enter the numeric identifier of the application in the VK social network, information about which you want to display in the widget. How to find the application ID is described on the page above, in the “Obtaining a VK application identifier” section.

Example: 3083242

Widget Type

Type: Segmented buttons

Description: The option is responsible for the visual appearance of the application widget. There are three options of displayed information: card, member list and button.

Possible values:

  • Card – widget will show the app logo, title, category, number of participants and a “Play” button.
  • Member List – widget will show the app logo, title, category, number of participants, participant avatars and the “Play” button.
  • Button – widget will show a “Play” button.

Default: Card

Width

Type: Numeric field

Description: The field is responsible for the width of the widget with the application. It is specified by a number in pixels. This field is available if “View” is set to “Member List”.

Example: 200

Button height

Type: Segmented buttons

Description: The option is responsible for the height of the button in pixels. You can only select a value, you cannot enter your own. This field is available if «View» is set to «Button».

Possible values:

  • 18px.
  • 20px.
  • 22px.
  • 24px.
  • 30px.

Default: 18px

Module Activation

To activate the module in the CMS Joomla need to do several actions:

  1. Select the desired position of the template, where the module should be displayed on the site, in the «Position» option, on the right side of the module settings page.
  2. In the option below «Status» you must select the «Published» value.
  3. Next, you need to bind the module to the pages of the site. In the upper part of the settings on the module page, click on the «Menu assignment» tab.
  4. A tab opens with a single option «Module assignment». Select the value depending on the pages on which you want the module to be displayed. In the example, select «On all pages» – the module will be available on all pages of the site. 
  5. Click the «Save» button. The settings will be saved and the module will be displayed on the site.

Error update module

If you have an error when updating a module in the control panel of Joomla, then this section of the instructions is necessary for you. Usually the error when updating looks like this:

Joomla extension update error

This error appears in several cases, they are all related to the module’s license key.

1) You have not filled in the license key in the module settings.

Go to the module settings and check if the «License key» field is filled in. Without a license key it is not possible to download updates. There is a time when you added a license key, but CMS Joomla did not save it correctly, for this module settings after entering a license key, click «Save» and then click «Save and 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 of your module and in the «Valid until» column check its relevance. If the license key has expired, it is not possible to get updates. To resolve this issue: place a new order and get 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 accessed it. In case you try to use the license key on several sites, the updates will be available only for one site. If you need updates for multiple sites, make a purchase of multiple license keys from the site. Sites without license keys will not be able to receive updates.

Attention! If you have changed the address of the site and can not download updates, write to us at support@iws.by with the new address of the site, 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.

The support service also responds on the official support forum iws.by: Go to.