1.0
OAS 3.0
To access UserWay’s Public API, you will need to receive an API key at this point.
Follow the steps below to scan your website:
Start indexing your sitemap: POST /scanner/sites/sitemap
Track the ongoing process: GET /scanner/sites/{siteId}/sitemap
endpoint.
After the sitemap indexing is complete, use the POST /scanner/sites/{siteId}/scan
endpoint to actually start scanning.
Track the crawling process: GET /scanner/sites/{siteId}
and recentSiteScan
field.
No further authorization is required.
To access this API contact support to enable the Agency account
Steps to enable product on the site:
Get ID
of your AgencySubscription
: GET /agency/subscriptions
See list of sites: GET /widget/sites
Get ID of your Site
by its host: GET /widget/sites/exchange
Enable product on existing site by ID: POST /agency/subscriptions/{agencySubscriptionId}/sites/{siteId}/enable
(REMEDIATION
is a Widget)
Create site by host and enable product: POST /agency/subscriptions/{agencySubscriptionId}/sites
Create batch of sites by hosts and enable REMEDIATION
: POST /agency/subscriptions/{agencySubscriptionId}/sites/add-batch
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