API reference

Base URL https://cloviable.com. Responses are JSON unless noted.

Authentication

Sign in with POST /api/auth/login; send the returned token as Authorization: Bearer <token>. Endpoints marked auth return 401 {"error":"Unauthorized"} without it.

curl -X POST https://cloviable.com/api/auth/login \
  -H 'Content-Type: application/json' \
  -d '{"email":"[email protected]","password":"…"}'

Public

GET/report?domain={domain}

The public report page for a domain (HTML). Results are cached; a fresh scan is rate-limited per domain.

GETPOST/api/generate-statement

Draft an accessibility statement. Parameters: domain (required), org_name, contact_email. Returns ok, domain, engine and the statement. 400 if domain is missing.

curl 'https://cloviable.com/api/generate-statement?domain=example.com&org_name=Example%20Inc'

GET/api/widget/config?site={site_key}

Visitor panel settings for a site (see Install).

POST/api/issues

Let a visitor report an accessibility problem. JSON body: domain, key (site key), issue_type, description (up to 2,000 characters), url.

Your sites (auth)

GET/api/my/sites

Sites on your account.

GET/api/my/sites/{site_key}

One site with its settings. 404 if it is not yours.

POST/api/my/sites/{site_key}/config

Update panel settings. Body: the settings object, or {"config": {…}}. Returns {"ok": true, "config": {…}}.

GET/api/my/sites/{site_key}/scan

Scan the site now and store the result in its history. Returns the score and issues, plus your plan usage. 502 if the site cannot be fetched.

GETPOST/api/keys DELETE/api/keys/{key_id}

List, create and revoke API keys.

GET/api/auth/me

The signed-in account.

Questions or a missing endpoint? Use the contact link in the footer.