Customer API Keys for Personalised Feeds

A Customer API Key gives a B2B customer their own feed URL. The feed lists your catalogue with that customer's prices instead of your general prices, so the customer can import it into their own systems, such as an ERP, a marketplace, or a spreadsheet.

Without a key, a feed URL returns your general catalogue.

Step 1: Create a Customer API Key

In Shopranos Admin, go to Customers → Settings → Customer API Keys.

Select Create API Key and fill in:

Name: a label you will recognise, for example the customer's company name.

Customer: the customer whose prices the feed should show.

Expiration Date: the date after which the key stops working.

Permissions: what else the key may access. The feed does not need a specific permission: its prices always come from the selected customer.

Save the key.

To invalidate a key, open it and select Generate a new key. The previous key stops working immediately, so any feed URL that contains it must be replaced.

Anyone with the key can read the feed. Share it only with that customer, and never publish it on a website or in a public repository.

Step 2: Copy the personalised feed URL

Go to Settings → Feeders → Feeders and open the feeder you want to share. If it is new, save it first: feed URLs appear only after the feeder is saved.

Make sure the feeder is Active. Inactive feeders are not generated.

In the Feed URLs section, select the Customer, and then the API Key you created in Step 1.

For a Custom Feeder, optionally select a Transformation.

Select Copy next to the feed type you need, and send the URL to the customer.

Feed URL format

https://platform.shopranos.eu/api/feeders/feed/{feedType}/{companyId}/{feederId}?apikey={customerApiKey}

Parameter	Description
`feedType`	The feed format. See the table below.
`companyId`	Your company ID. Filled in for you by Copy.
`feederId`	The ID of the feeder. Filled in for you by Copy.
`apikey`	Optional. The Customer API Key. Without it, the feed shows your general prices.
`transformationId`	Optional, `Custom` feeds only. The transformation that shapes the output.

`feedType`	Shown in Admin as
`Json`	Json Feeder
`XMLV2`	XML Feeder
`XML`	XML Feeder (deprecated; use `XMLV2`)
`Skroutz`	Skroutz Feeder
`Facebook`	Facebook Feeder
`BestPrice`	BestPrice Feeder
`Pinterest`	Pinterest Feeder
`Custom`	Custom Feeder

How the feed behaves

First request: the feed is generated in the background. Until it is ready, the URL returns:

{"Response":"This feed is not available right now. It will be generated in a few minutes"}

Try again after a few minutes.

Refresh: after that, the URL returns the latest generated file straight away, and the feed is regenerated on the feeder's schedule. Each customer key has its own copy of the feed.

Caching: responses include an ETag header. Send it back in If-None-Match and you get 304 Not Modified when the feed has not changed.

Invalid key: a key that is wrong, expired, deleted or regenerated returns 401 Unauthorized. Copy the URL again with a valid key. A copy that was already generated with the old key may still be served until the next refresh.

Customer API Keys for Personalised Feeds

Step 1: Create a Customer API Key#

Step 2: Copy the personalised feed URL#

Feed URL format#

How the feed behaves#

Step 1: Create a Customer API Key

Step 2: Copy the personalised feed URL

Feed URL format

How the feed behaves