Documentation: VK App Widget for Joomla from iws.by
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
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
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.
The number 5327745 is the unique numeric identifier of the VK application. Memorize it or save it, it is needed to configure the module.
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. Usually, the update error looks like this:
This 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.