This page provides instructions for admin users on how to retrieve the API key and URL from an existing Web Governance account to connect it to an Acquia Source site.

How to get the API key and URL from Web Governance 

• Log in to your Web Governance account.
• Click Admin Settings (gear icon) on the top menu bar.

• Click API Users in the left menu.

  Add a new API user if needed.

• Click Action on the same row as an existing API user in the list.
• Select See API Token.
• Copy the token from the token window and paste it in the applicable field in Acquia Source.
• Copy the corresponding API URL from the list and paste it in the applicable field in Acquia Source.

For instructions on how to connect an existing Web Governance account to your Acquia Source account, visit Connecting a Web Governance account to Acquia Source.

Quick Scan overview

This section provides information about the issues that the Quick Scan can identify.

When you click Start Quick Scan in Acquia Source Experience Builder:

• The system displays a progress bar to show the scan render progress. When this process is complete, the results are loaded and the rendered page is sent to the Web Governance API for the scan.
• When the module receives the results, you can view them summarized in the following categories:

  • Accessibility: Issues are summarized by guideline level (WCAG 2.1 A, WCAG 2.1 AA).

    For more information, visit Accessibility feature.

  • Readability: Issues are shown as a level, mapped from the resulting score.

    For more information about readability scores, visit Quality Assurance Readability.

  • SEO: For more information, visit Search engine optimization.
  • Data Privacy Topics: For more information, visit Data privacy.

If you have a Web Governance account, navigate to the Web Governance UI to view the full reports.

Errors

The following errors can occur with a scan. This list provides the error name and a short description about what the error means:

• Error: There was an error gathering the content. Please try again.

  Description: The module is unable to build the payload.

• Error: The scan request has timed out. Please try again later.

  Description: The API does not respond or times out.

• Error: Access to the Web Governance API was denied. Contact your administrator for help.

  Description: The API provided does not have permission for the Quick Scan feature (422).

• Error: Could not connect to the Web Governance API due to a server error. Please try again later.

  Description: The API has failed (500-5xx).

Additional resources

For more information, visit Acquia Web Governance user documentation.

Retrieving the API token from Web Governance for Acquia Source setup