Authenticate with WooCommerce

You can authenticate with WooCommerce to create your own instance of the WooCommerce element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the WooCommerce platform.

Authenticate Through the UI

Use the UI to authenticate with WooCommerce and create an element instance. You will need your Consumer Key and Consumer Secret that you identified in API Provider Setup.

If you are configuring events, see the Events section.

To authenticate an element instance:

1. Sign in to Cloud Elements, and then search for WooCommerce in our Elements Catalog.
2. Hover over the element card, and then click Authenticate.
3. Enter a name for the element instance.
4. In The Store URL enter the url of your WooCommerce Storefront.
5. In OAuth API Key and OAuth API Secret enter your Consumer Key and Consumer Secret.
6. Optionally type or select one or more Element Instance Tags to add to the authenticated element instance.
7. Click Create Instance.

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a virtual data resource, or use it in a formula template.

Authenticate Through API

Authenticating through API is similar to authenticating via the UI. Instead of clicking and typing through a series of buttons, text boxes, and menus, you will instead send a request to our /instances endpoint. The end result is the same, though: an authenticated element instance with a token and id.

To authenticate an element instance:

1. Construct a JSON body as shown below (see Parameters):

   {
     "element": {
       "key": "woocommercerest"
     },
     "configuration": {
       "store.url": "<WEB_STORE_URL>",
       "oauth.api.key": "<CONSUMER_KEY>",
       "oauth.api.secret": "<CONSUMER_SECRET>"
     },
     "tags": [
       "<Add_Your_Tag>"
     ],
     "name": "<INSTANCE_NAME>"
   }
   

2. Call the following, including the JSON body you constructed in the previous step:

   POST /instances
   

   Note: Make sure that you include the User and Organization keys in the header. See the Overview for details.

3. Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "woocommercerest"
  },
  "configuration": {
    "store.url": "<http://mycoolstore.com>",
    "oauth.api.key": "xxxxxxxxxxxxxxxxxx",
    "oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "tags": [
    "Docs"
  ],
  "name": "API Instance"
}'

Parameters

API parameters not shown in Cloud Elements are in code formatting.

Example Response for an Authenticated Element Instance

In this example, the instance ID is 12345 and the instance token starts with "ABC/D...". The actual values returned to you will be unique: make sure you save them for future requests to this new instance.

{
  "id": 12345,
  "name": "API Instance",
  "createdDate": "2017-08-07T18:46:38Z",
  "token": "ABC/Dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "element": {
    "id": 2881,
    "name": "WooCommerce",
    "hookName": "WooCommercewp",
    "key": "woocommercerest",
    "description": "Add a Woocommerce (using WordPress REST) Instance to connect your existing Woocommerce account to the eCommerce Hub, allowing you to manage orders and products across multiple eCommerce Elements. You will need your Woocojmmerce API information to add an instance.",
    "image": "https://pbs.twimg.com/profile_images/378800000726053868/44a02004f2aeab0534c26fb5afc37784_400x400.png",
    "active": true,
    "deleted": false,
    "typeOauth": false,
    "trialAccount": false,
    "resources": [ ],
    "transformationsEnabled": true,
    "bulkDownloadEnabled": true,
    "bulkUploadEnabled": true,
    "cloneable": true,
    "extendable": false,
    "beta": false,
    "authentication": {
        "type": "custom"
    },
    "extended": false,
    "hub": "ecommerce",
    "protocolType": "http",
    "parameters": [  ],
    "private": false
    },
    "elementId": 2881,
    "tags": [
        "Docs"
    ],
    "provisionInteractions": [],
    "valid": true,
    "disabled": false,
    "maxCacheSize": 0,
    "cacheTimeToLive": 0,
    "configuration": {    },
    "eventsEnabled": false,
    "cachingEnabled": false,
    "externalAuthentication": "none",
    "traceLoggingEnabled": false,
    "user": {
        "id": 12345
      }
}