Connection

Report the plugin's version and push address

Connection key only. Permission connection:manage. A site_url whose host differs from the connected one gives 409 and the plugin must pause: this is how a staging copy of a site is stopped from sending orders to the live store.

put/connection

Request

  • Base URL: https://sitesplaced.com/api/v1
  • URL: https://sitesplaced.com/api/v1/connection
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Request body

plugin_versionstring
platform_versionstring
site_urlstring uri

A host that differs from the connected one gives 409.

push_urlstring nullable

Where SitesPlaced pushes updates. Null when the shop's REST API cannot be reached.

shop_namestring
currencystring

Example request

{
  "plugin_version": "1.0.0",
  "push_url": "https://shop.example.com/wp-json/sitesplaced/v1/updates",
  "currency": "INR"
}

Response

The connection and its store.

Example response

{
  "connection": {
    "platform": "woocommerce"
  }
}

Changes

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