Allow a website to show your widgets

Adds a website to an account’s own list. Give a website name such as example.com, or *.example.com for a website and all of its subdomains. A scheme, a port, a path, capital letters and a leading www. are dropped, so https://www.Example.com/shop is kept as example.com, and example.com covers www.example.com too. Something that is not a website name is refused, not stored. Until the first website is added nothing is restricted, and a widget can be shown anywhere. Once the list has one, a widget of the account is shown on the listed websites (and on Widgetic’s own) and nowhere else. A page on your own machine (localhost, 127.0.0.1 or [::1], on any port) is always allowed, so there is nothing to add to test locally. So is the website where a partner your account administers integrates Widgetic, with every subdomain of it (platformDomain in the answer of GET /partners/mine), so there is nothing to add for it either and a list can never lock it out. A change can take about 15 seconds to reach every server. The list is a safeguard against other websites showing your widgets in a visitor’s browser. It is not access control: anyone who knows a widget’s id can still fetch its published content with a plain request that names no website. There is no limit on the list of an account that administers a partner, so a partner can add the website of each of its customers as they publish on their own domain, one call each. Any other account can list at most 50 websites, and the 51st is answered with a 409 (BUSINESS_STATE_CONFLICT). A wildcard such as *.example.com counts as one website, not one per subdomain, so use it instead of listing each subdomain. A page that frames a widget can name only so many websites to the browser (about fifty of ordinary length). Past that, the browser no longer checks the list for that page; the lookup that the Embed SDK makes for the widget still refuses every website that is not on the list.

POST /users/{id}/workspace/domains

Allow a website to show your widgets

cURL

curl --request POST \
  --url https://api.widgetic.com/v1/users/{id}/workspace/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "example.com"
}
'

201

{
  "success": true,
  "data": {
    "message": "Domain added successfully",
    "domain": null
  },
  "meta": {
    "page": 1,
    "size": 20,
    "total": 135,
    "limit": 20,
    "offset": 0,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextCursor": "<string>",
    "warnings": [
      "<string>"
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string<uuid> · required

The account the list belongs to. For your own, your own user id

Body

application/json

domain · string · required

Domain pattern to allow (supports wildcards like *.example.com)

Example:

"example.com"

Response

201

application/json

The website was added

success · boolean · required

Always true on a success.

Example:

true

data · object · required

Show child attributes

Example:

{
  "message": "Domain added successfully",
  "domain": null
}

meta · object

Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat.

Show child attributes