Connection

Swap a one-time code for the plugin's key

No key: the plugin does not have one yet. The code works once, for 10 minutes, and only when the host of site_url matches the shop that was approved. Any failure gives 400.

post/connect/exchange

Request

  • Base URL: https://sitesplaced.com/api/v1
  • URL: https://sitesplaced.com/api/v1/connect/exchange
  • Auth: none required

Request body

codestring required
site_urlstring uri required

Example request

{
  "code": "spc_…",
  "site_url": "https://shop.example.com"
}

Response

The plugin's key and signing secret.

api_keystring required
webhook_secretstring required

Signs the updates pushed back to the shop.

connection_idstring uuid required

Example response

{
  "api_key": "sp_live_sk_…",
  "webhook_secret": "whsec_…"
}

Changes

No recorded changes to this operation across all 1 revision of this API.