You can add the EqualWeb accessibility widget to your Dev Portal to help meet your organization’s accessibility requirements. After it’s configured, the EqualWeb widget script will be injected into every page of your Dev Portal.
Add the EqualWeb accessibility widget to Dev Portal
Configure the EqualWeb widget with your Dev Portal domain. In your Dev Portal settings, click the Integrations tab and enable the EqualWeb integration. Add your EqualWeb site key and widget configuration.
Prerequisites
Dev Portal
For this tutorial, you’ll need a Dev Portal pre-configured. If you don’t have these settings already configured, follow these steps to pre-configure it:
- In the Konnect sidebar, expand Dev Portal.
- Click Portals.
- Click New portal.
- Enter a name for your Dev Portal.
- Click Create and continue.
- Customize your Dev Portal’s appearance.
- Click Save.
Get your EqualWeb site key
Before you configure the integration in Konnect, you need your Dev Portal domain and your EqualWeb site key.
- In the Konnect sidebar, expand Dev Portal.
- Click Portals.
- Click your Dev Portal.
- Copy your Dev Portal domain. This is the URL you’ll register in EqualWeb.
- In your EqualWeb account, click Add new site.
- In the Insert your domain field, enter your Dev Portal domain.
- Click Continue to customize design.
- Configure the widget design settings as needed.
- Click Continue to install widget.
- Click Collapse for your widget code. This will expand the widget configuration.
- Copy your site key from the
get sitekey (){ return "79ad2e1..."}field. For example:79ad2e1ec52e63565e254555077aaaec. -
(Optional) If you configured the widget design, copy the configuration. For example:
"Position": "left", "Menulang": "EN", "draggable": true, "btnStyle": { "vPosition": [ "80%", "80%" ], "margin": [ "0", "0" ], "scale": [ "0.5", "0.5" ], "color": { "main": "#1c4bb6", "second": "#ffffff" }, "icon": { "outline": false, "outlineColor": "#ffffff", "type": 1, "shape": "circle" } }The configuration you copy won’t be valid JSON. When you add it to the Dev Portal integration configuration, you’ll add
{}to make it valid.
Configure the EqualWeb integration
Configure the EqualWeb integration in your Dev Portal settings.
- In the Konnect sidebar, expand Dev Portal.
- Click Portals.
- Click your Dev Portal.
- Click the Settings tab.
- Click the Integrations tab.
- Click EqualWeb.
- Click the Enabled toggle.
- In the Site key, enter the site key from the EqualWeb widget you configured previously. For example:
79ad2e1ec52e63565e254555077aaaec. -
(Optional) If you configured the widget design in EqualWeb, click Advanced configurations and enter the JSON configuration in the configuration field with opening and closing brackets (
{}). For example:{ "Position": "left", "Menulang": "EN", "draggable": true, ... } - Click Save.
You can also configure the EqualWeb integration using the Konnect API by sending a PUT request to the /portals/{portalId}/integrations endpoint.
Validate
You can verify that the integration is working as expected by navigating to your Dev Portal URL. The EqualWeb accessibility widget should display on the page. It can take several minutes to display the widget after you’ve enabled the integration.