Errors

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.

Common Errors

401 Unauthorized

To provide less information to potential bad actors, when an account API key or Secret key are incorrect the only information returned will be 401 Unauthorized. In the event you receive this error, please contact us dev@shedsforsale.com to get access and secret keys assigned.

403 Forbidden

If you do not provide a partner key in a header named x-api-key with your request, the request will be returned with a 403 Forbidden code. In the event you receive this error, please contact us dev@shedsforsale.com to get a partner key assigned.