API Calls
Manufacturers
API Calls can be made to the endpoint api.shedsforsale.com and can be used to access the live, production API.
Authentication
To authenticate via the API, you must provide your partner API key in the headers as x-api-key. In addition, a valid API key and Secret key are required to authenticate against the customer account. Keep these keys secure. Please contact us at dev@shedsforsale.com in order to get a partner, access, and secret keys assigned to be able to connect to the API.
Retrieving manufacturers
ShedsForSale.com offers customers an experience that allows them to find sheds based on the manufacturer. Therefore, it is required that each product be assigned to a given manufacturer. In order to obtain a list of manufacturers with their corresponding ID, use the manufacturers endpoint.
As mentioned in the "Getting started" section, it is possible to require users to setup their API keys in such a way that a manufacturer is not required when creating and updating products.
Request example
axios({
method: 'get',
auth: {
username: 'CUSTOMER_API_KEY_HERE',
password: 'CUSTOMER_SECRET_KEY_HERE',
},
headers: {
'x-api-key': 'PARTNER_API_KEY_HERE',
},
url: '/integration/manufacturers',
})
