- The API described here is loosely based on REST principles. This means among other things that all endpoints can be accessed via HTTPS and http HTTP clients like curl or postman can be used directly to explore the API.
- The base url for all requests is https://api.spreadshirt.net for eu or https://api.spreadshirt.com for na. (This only applies to REST resources, images are retrieved from https://image.spreadshirtmedia.net or https://image.spreadshirtmedia.com.)
All requests have to be made with HTTP headers "Authorization" and "User-Agent". The authorization header must include your API key and the user agent header must include the name of your application, then its version, followed by a domain and a contact email address:
Header Key Header Value Format Example Header Value Authorization SprdAuth apiKey="<apikey>" SprdAuth apiKey="dd30b4db-8cd6-4fb8-86b3-e680984b9e18" User-Agent <YourApplication>/<YourApplicationVersion> (https://www.yourdomain.com; firstname.lastname@example.org) WordPress-Plugin/1.0 (https://www.deinblog.com; email@example.com)
Failing to provide this information may result in your requests getting blocked at any point in time because traffic of unknown source can be considered illegetimateillegitimate.
- All requests should be performed with a ?mediaType=json query parameter to get the responses in the recommended JSON format. Leaving the parameter out may or may not result in a response in XML format which is harder to work with.
- All REST ressources resources return HTTP status code 200 or 201 in case of successful requests. Status codes from the 4xx range indicate a mistake on your side while errors from the 5xx range indicate an error on ours.
- Timestamps are returned in ISO8601 format.