api.userway.org
Open in
urlscan Pro
2600:1f14:5db:eb00:c402:22f3:c63d:6484
Public Scan
Submitted URL: http://cdn77.api.userway.org/
Effective URL: https://api.userway.org/api/open/v0/api-docs/
Submission: On June 04 via api from LU — Scanned from DE
Effective URL: https://api.userway.org/api/open/v0/api-docs/
Submission: On June 04 via api from LU — Scanned from DE
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 API
To access this API contact support to enable the Agency account
Steps to enable product on the site:
1. Get ID of your AgencySubscription: GET /agency/subscriptions
2. See list of sites: GET /widget/sites
3. Get ID of your Site by its host: GET /widget/sites/exchange
4. Enable product on existing site by ID: POST
/agency/subscriptions/{agencySubscriptionId}/sites/{siteId}/enable
(REMEDIATION is a Widget)
5. Create site by host and enable product: POST
/agency/subscriptions/{agencySubscriptionId}/sites
6. Create batch of sites by hosts and enable REMEDIATION: POST
/agency/subscriptions/{agencySubscriptionId}/sites/add-batch
7. Disable product by ID: POST
/agency/subscriptions/{agencySubscriptionId}/sites/{siteId}/disable
There are also host-based alternatives for all site-related endpoints above.
Please see /exchange 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 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.
GET/api/open/v0/consumer/widget/sites/exchange
Returns Site details by host.
AGENCY ACCOUNTS
GET/api/open/v0/consumer/agency/accounts/{userId}/context
Returns general information breakdown for the Agency account
PUT/api/open/v0/consumer/agency/accounts/{userId}/billing-descriptor
Updates billing descriptor of all further payments within the Agency account
AGENCY SITES
POST/api/open/v0/consumer/agency/subscriptions/{agencySubscriptionId}/sites
Creates Site and enables particular product
GET/api/open/v0/consumer/agency/subscriptions/{agencySubscriptionId}/sites
Returns list of Sites within Agency Subscription
POST/api/open/v0/consumer/agency/subscriptions/{agencySubscriptionId}/sites
/add-batch
Creates batch of sites and enables REMEDIATION product
POST/api/open/v0/consumer/agency/subscriptions/{agencySubscriptionId}/sites
/disable-batch
Disables product for the batch of sites
GET/api/open/v0/consumer/agency/subscriptions/{agencySubscriptionId}/sites
/{siteId}
Returns list of enabled products on the Site by ID
DELETE/api/open/v0/consumer/agency/subscriptions/{agencySubscriptionId}/sites
/{siteId}
Disables all products and deletes Site by ID
GET/api/open/v0/consumer/agency/subscriptions/{agencySubscriptionId}/sites
/exchange
Returns list of enabled products on the Site by host
DELETE/api/open/v0/consumer/agency/subscriptions/{agencySubscriptionId}/sites
/exchange
Disables all products and deletes Site by host
GET/api/open/v0/consumer/agency/subscriptions/{agencySubscriptionId}/sites
/{siteId}/billing
Returns billing information for the Site by ID
GET/api/open/v0/consumer/agency/subscriptions/{agencySubscriptionId}/sites
/exchange/billing
Returns billing information for the Site by host
POST/api/open/v0/consumer/agency/subscriptions/{agencySubscriptionId}/sites
/{siteId}/enable
Enables product on the Site within Agency Subscription by ID
POST/api/open/v0/consumer/agency/subscriptions/{agencySubscriptionId}/sites
/exchange/enable
Enables product on the Site within Agency Subscription by host
POST/api/open/v0/consumer/agency/subscriptions/{agencySubscriptionId}/sites
/{siteId}/disable
Disables product on the Site within Agency Subscription by ID
POST/api/open/v0/consumer/agency/subscriptions/{agencySubscriptionId}/sites
/exchange/disable
Disables product on the Site within Agency Subscription by host
AGENCY SUBSCRIPTIONS
PATCH/api/open/v0/consumer/agency/subscriptions/{agencySubscriptionId}/name
Updates name of the Agency Subscription
PATCH/api/open/v0/consumer/agency/subscriptions/{agencySubscriptionId}
/payment-data
Updates Payment Data of the Agency Subscription
GET/api/open/v0/consumer/agency/subscriptions/{agencySubscriptionId}
Returns Agency Subscription
GET/api/open/v0/consumer/agency/subscriptions
Returns list of all Agency Subscriptions
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
SiteAddonsDto
SiteBriefDto
GetSitesBriefResponseDto
GetSiteBriefByIdResponseDto
SiteOpensLoadsHistoryDto
SiteUsageStatsFeaturesDto
SiteUsageStatsDto
SiteUsageStatsDaysSeparationDto
GetSiteUsageStatsResponseDto
ToggleWidgetVisibilityResponseDto
ToggleWidgetVisibilityDto
RemediationFocusStylingDto
SiteRemediationFocusDto
GetSiteRemediationFocusResponseDto
UpdateSiteRemediationFocusResponseDto
UpdateSiteRemediationFocusDto
SiteDetailsDto
AgencySubscriptionPreviewDto
PaymentCardDetailsDto
PaymentMethodDetailsDto
AgencySitesTotalsDto
AgencyQuotaTotalsDto
AgencyAccountDiscountDto
InvoiceTotalsDto
AgencySubscriptionUpcomingInvoiceDto
AgencyAccountContextDto
AgencyAccountUpdateBillingDescriptorDto
CreateSiteResponseDto
AgencySiteCreateAndEnableDto
AddSitesBatchSiteDetails
AgencyAddSitesBatchResponseDto
AgencyAddSitesBatchDto
AgencyDisableSitesBatchResponseDto
AgencyDisableSitesBatchDto
AgencySiteConfigDetailsWithHostDto
AgencySubscriptionSitesDto
AgencySiteConfigDetailsDto
AgencySiteOptionsDto
AgencySiteBillingDetailsDto
AgencySiteEnableProductDto
AgencySiteDisableProductDto
AgencySubscriptionUpdateNameDto
AgencySubscriptionUpdatePaymentDataDto
AgencySubscriptionDto
AgencySubscriptionListDto
SubresourceIntegrityDto
ServiceErrorResponseDto