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

Scanner

Widget Users

Widget Sites

Agency Accounts

Agency Sites

Widget