api.userway.org
Open in
urlscan Pro
2600:1f14:5db:eb00:7f13:1cbb:e9d1:a6db
Public Scan
Submitted URL: http://cdn77.api.userway.org/
Effective URL: https://api.userway.org/api/open/v0/api-docs/
Submission: On January 11 via api from CH — Scanned from CH
Effective URL: https://api.userway.org/api/open/v0/api-docs/
Submission: On January 11 via api from CH — Scanned from CH
Form analysis 1 forms found in the DOM
<form class="download-url-wrapper"><input class="download-url-input" type="text" value=""><button class="download-url-button button">Explore</button></form>Text Content
Explore
USERWAY API
1.0
OAS 3.0
GETTING STARTED GUIDE
To access UserWay’s Public API, you will need to receive an API key at this
point.
SCANNER API
Follow the steps below to scan your website:
1. Start indexing your sitemap: POST /scanner/sites/sitemap
2. Track the ongoing process: GET /scanner/sites/{siteId}/sitemap endpoint.
3. After the sitemap indexing is complete, use the POST
/scanner/sites/{siteId}/scan endpoint to actually start scanning.
4. Track the crawling process: GET /scanner/sites/{siteId} and recentSiteScan
field.
WIDGET API
USERS
No further authorization is required.
AGENCY USERS
Only agency users can access these endpoints.
UserWay Support - Website
Send email to UserWay Support
Authorize
SCANNER
GET/api/open/v0/consumer/scanner/sites/{siteId}/stats
Returns violations statistics per site and the number of ongoing scans.
GET/api/open/v0/consumer/scanner/sites/{siteId}/entry-stats
Returns violations statistics aggregated by a website page.
GET/api/open/v0/consumer/scanner/sites
Lists all websites added to the account.
GET/api/open/v0/consumer/scanner/sites/{siteId}
Retrieves a website by its ID. Can be used to track an ongoing scan.
POST/api/open/v0/consumer/scanner/sites/{siteId}/scan
Starts the scan of a specified website.
POST/api/open/v0/consumer/scanner/sites/sitemap
Starts new sitemap indexing. Should be used as the initial step.
GET/api/open/v0/consumer/scanner/sites/{siteId}/sitemap
Retrieves sitemap of a website. Can be used to track an ongoing indexing.
PATCH/api/open/v0/consumer/scanner/sites/{siteId}/scan-region
Updates the region from which the scanner conducts its crawling.
PATCH/api/open/v0/consumer/scanner/sites/{siteId}/toggle-proxy
If switched on, scanner will use a static IP address corresponding to its
region.
PATCH/api/open/v0/consumer/scanner/sites/{siteId}/toggle-monitoring
Enables or disables real-time monitoring.
PATCH/api/open/v0/consumer/scanner/sites/{siteId}/monitoring-frequency
Updates real-time monitoring frequency.
WIDGET USERS
GET/api/open/v0/consumer/widget/users/{code}/accessibility-report
Generates accessibility report for a given API key.
GET/api/open/v0/consumer/widget/users/{code}/subscription
Retrieves current subscription plan.
POST/api/open/v0/consumer/widget/users
Creates a team member (child user) with a new website.
WIDGET AGENCY USERS
GET/api/open/v0/consumer/widget/agency/users/stats
Retrieves account statistics for a given API key.
WIDGET SITES
GET/api/open/v0/consumer/widget/sites
Lists websites that belong to the account.
GET/api/open/v0/consumer/widget/sites/{siteId}
Retrieves a website by ID.
GET/api/open/v0/consumer/widget/sites/{siteId}/products/usage-stats
Returns stats for an account with purchased usage stats product.
POST/api/open/v0/consumer/widget/sites/{siteId}/visibility
Toggles widget visibility on your website.
GET/api/open/v0/consumer/widget/sites/{siteId}/remediation/focus
Retrieves remediation focus styling and its state.
PUT/api/open/v0/consumer/widget/sites/{siteId}/remediation/focus
Modifies remediation focus styling and its state.
WIDGET AGENCY SITES
GET/api/open/v0/consumer/widget/agency/sites/{siteId}
Retrieves a website with its paid products.
POST/api/open/v0/consumer/widget/agency/sites/{siteId}/enable-product
Enables a particular product.
POST/api/open/v0/consumer/widget/agency/sites/{siteId}/disable-product
Disables a particular product.
WIDGET
GET/api/open/v0/consumer/widget/sri/latest
Provides Subresource Integrity (SRI)
SCHEMAS
ScannerDateDto
SiteScanStatsResponseDto
SiteScanEntryStatsResponseDto
SiteScanCsvExportDto
SiteScanPdfExportDto
SiteScanDto
SiteResponseDto
ScanMessageResponseDto
SitemapStatsDto
SitemapCrawlDto
SitemapScanDto
SitemapDto
SitemapNoeDto
IndexNewSitemapResponseDto
UpdateScanRegionDto
UpdateScanProxyDto
ToggleMonitoringDto
UpdateMonitoringFrequencyDto
GetA11yReportLinkResponseDto
GetUserSubscriptionResponseDto
WidgetInstallInfoDto
CreateChildUserAndSiteResponseDto
CreateChildUserAndSiteDto
AgencyAccountSummarySitesDto
AgencyAccountDiscountDto
AgencyAccountUpcomingInvoiceDto
GetAgencyUserStatsResponseDto
SiteAddonsDto
SiteBriefDto
GetSitesBriefResponseDto
GetSiteBriefByIdResponseDto
SiteOpensLoadsHistoryDto
SiteUsageStatsFeaturesDto
SiteUsageStatsDto
SiteUsageStatsDaysSeparationDto
GetSiteUsageStatsResponseDto
ToggleWidgetVisibilityResponseDto
ToggleWidgetVisibilityDto
RemediationFocusStylingDto
SiteRemediationFocusDto
GetSiteRemediationFocusResponseDto
UpdateSiteRemediationFocusResponseDto
UpdateSiteRemediationFocusDto
AgencySiteOptionsDto
AddonDto
AgencySiteUserServiceDto
AgencySiteSubscriptionDto
SubscriptionPairDto
UserPaidProductMetaSiteDto
UserPaidAddonDto
AgencySiteProductsDto
GetAgencySiteResponseDto
ToggleAgencySiteProductResponseDto
ToggleAgencySiteProductDto
SubresourceIntegrityDto
ServiceErrorResponseDto