Submitting Data Feeds
There are three ways of submitting feeds to PureClarity:- Via a HTTP POST request to /api/productfeed to PureClarity, passing the URL where PureClarity can download it.
- Securely submitting a feed via SFTP.
- Securely streaming feeds as batches to PureClarity via HTTPS
- Once a feed has been submitted you can see the progress of processing under Settings > Feed Management in the PureClarity Admin console.
Submitting Via HTTPS
You can make a HTTPS POST request to the PureClarity endpoint /api/productfeed passing the URL where PureClarity can download a full JSON feed as part of the body. The productfeed API reference details this endpoint.Submitting Using SFTP
You can submit feeds securely via SFTP. Endpoints are region specific and are as follows:| Region | Endpoint | Port |
|---|---|---|
| EU | sftp-eu-w-1.pureclarity.net | 2222 |
| US | sftp-us-e-1.pureclarity.net | 2222 |
Ensure that the Secret Key is never revealed.
Submitting Using HTTP Stream Requests
For systems that cannot submit using an SFTP server PureClarity can receive feeds via multiple HTTP requests. Using this API you can send the feed in multiple API calls to build up a complete JSON object inside of PureClarity. This is done by appending strings to a remote file on the PureClarity server. You first send a create command with an opening JSON bracket, followed by an append command building up the items, finishing with a close command and appending a close JSON bracket. Once the close command is received PureClarity will begin processing the feed. The three endpoints are as follows:https://<region-domain>/feed-createhttps://<region-domain>/feed-appendhttps://<region-domain>/feed-close
<region-domain> for the streaming API uses HTTPS and is as follows:
| Region | Endpoint | Port |
|---|---|---|
| EU | sftp-eu-w-1.pureclarity.net | 443 |
| US | sftp-us-e-1.pureclarity.net | 443 |
Each request must be a HTTPS POST request.Each of the three calls should contain a JSON body with the following 4 properties:
| Property | Description |
|---|---|
| accessKey | The store view Access Key. |
| secretKey | The store view Secret Key. |
| feedName | A unique identifier for the feed. This should be the same for each of the 3 calls. |
| payLoad | The next part of the string that builds up the feed file. |
payLoad is a string, NOT a JSON object
Start of feed: /feed-create
This indicates to PureClarity that a new feed is being sent. You should include the start of the feed in the payLoad if required. Typically you would send over the opening brace of the JSON feed in the payLoad along with the start of property array that will hold the items. For example:"{"
This is a string that is being sent, and not a JSON object.
Data in the feed: /feed-append
Use consecutive calls to the append endpoint to send parts of the feed, such as the header for the item array, followed by multiple calls containing the items, followed by another call to end the array. For example, the header for a products feed may look like:"Products": ["
Then the addition of products:
{"Id":"prod123","Title":"A sample product","Prices":["3.99 GBP","4.99 USD"]},
Take care to ensure commas are not appended to the last item. Remember these strings are appending to a file on the server to generate valid JSON.
"]"
You can repeat the above to include other sections for the feed if required (i.e. categories and brands) although these can also be sent as separate feeds.
End of feed: /feed-close
Use this call once you are ready to submit the feed to PureClarity for processing. You can include the final part of the feed in the request if required. Once PureClarity has received this it will process the file. Typically you would send over the closing brace of the JSON feed in the payLoad:"}"