Last modified by admin on 2023/02/14 14:43
<
From version < 7.1 >
edited by Admin
on 2010/03/06 16:07
To version < 52.1 >
edited by Shop Team
on 2019/08/01 09:25
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Home
1 +Spreadshirt Public Shop API Documentation
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Admin
1 +XWiki.shop
Content
... ... @@ -1,39 +1,62 @@
1 -Spreadshirt API makes most of the features of our platform available via programmabl REST services. Spreadshirt API is **one part of our strategy to provide Customized Apparel as a Service (CAaaS)** that I described in the General space. Spreadshirt API is right now available in version 1 (v1).
1 += Preface =
2 2  
3 -[[api-parts.png>>image:api-parts.png||border="1" align="center"]]
3 +Spreadshirt provides several ways to offer an online shop experience to your customers and earn money through commission:
4 4  
5 -**API Features**
5 +1. The standalone Spreadshop ([[this>>url:https://shop.spreadshirt.com/SpreadShop||rel="nofollow" shape="rect" class="external-link"]], for example). This application is officially developed, hosted and maintained by Spreadshirt. Running a Spreadshop requires zero technical skills and is always the recommended approach.
6 +1. JavaScript integration (described [[here>>url:https://help.spreadshirt.com/hc/en-us/articles/207487815-Website-Integration-with-JavaScript||rel="nofollow" shape="rect" class="external-link"]]). If you have an existing website, you can embed a piece of JavaScript into it that manipulates your website in order to embed the Spreadshop into your site. This requires a decent understanding of HTML and CSS in order to resolve any conflicts between your site and the Spreadshop that may arise.
7 +1. CMS plugins for [[WordPress>>url:https://wordpress.org/plugins/spreadshop/#developers||rel="nofollow" shape="rect" class="external-link"]] and others (currently just [[Joomla>>url:https://extensions.joomla.org/extension/spreadshop/||rel="nofollow" shape="rect" class="external-link"]]) that embed the JavaScript snippet mentioned in (2.) for you. If you run a website based on such CMS, these plugins can make your life a bit easier. An understanding of HTML and CSS is nonetheless important.
8 +1. An independent, custom built web application based on the **Public Shop API** described in this document. This interface is for web developers only (or people who can afford to hire one). Going for this approach is only feasible for people who have a solid understanding of server side & client side programming, HTTP, HTML and CSS.
6 6  
7 -**Today**, API v1 provides the following features:
10 += Prerequisites =
8 8  
9 -* **Retrieve images** for designs, products, product types, print types, etc.,
10 -* **Retrieve data** for designs, products, articles, product types, print types, etc.,
11 -* **Create baskets** and forward to Spreadshirt HTML checkout and
12 -* **Store and retrieve widget configurations**.
12 +Spreadshirt runs a European and a North American platform that are independent from another. First, you need to register a Spreadshop on [[eu>>url:https://www.spreadshirt.net/start-selling-C5780||shape="rect"]] or [[na>>url:https://www.spreadshirt.com/start-selling-shirts-C3598||shape="rect"]]. Then, in order to use the API, you need to register an API Key on [[eu>>url:https://www.spreadshirt.net/userarea/-C7120||shape="rect"]] or [[na>>url:https://www.spreadshirt.com/userarea/-C6840||shape="rect"]].
13 13  
14 -For the **next releases**, we plan to provide the following features:
14 += Basics =
15 15  
16 -* **Design upload** and **product creation**,
17 -* **Design and article search** for marketplace and
18 -* **Better basket integration**.
16 +* The API described here is loosely based on [[REST>>url:https://en.wikipedia.org/wiki/Representational_state_transfer||shape="rect"]] principles. This means among other things that all endpoints can be accessed via HTTPS and http clients like [[curl>>url:https://curl.haxx.se/||shape="rect"]] or [[postman>>url:https://www.getpostman.com/||shape="rect"]] can be used directly to explore the API.
17 +* The base url for all requests is [[https:~~/~~/api.spreadshirt.net>>url:https://api.spreadshirt.net||shape="rect"]] for eu or [[https:~~/~~/api.spreadshirt.com>>url:https://api.spreadshirt.com||shape="rect"]] for na. (This only applies to REST resources, images are retrieved from [[https:~~/~~/image.spreadshirtmedia.net>>url:https://image.spreadshirtmedia.net||shape="rect"]] or [[https:~~/~~/image.spreadshirtmedia.com>>url:https://image.spreadshirtmedia.com||shape="rect"]].)
18 +* (((
19 +(% class="auto-cursor-target" %)
20 +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:
19 19  
20 -**API Technology**
22 +|=(((
23 +Header Key
24 +)))|=(((
25 +Header Value Format
26 +)))|=(((
27 +Example Header Value
28 +)))
29 +|(((
30 +Authorization
31 +)))|(((
32 +SprdAuth apiKey="<apikey>"
33 +)))|(((
34 +SprdAuth apiKey="dd30b4db-8cd6-4fb8-86b3-e680984b9e18"
35 +)))
36 +|(((
37 +User-Agent
38 +)))|(((
39 +<YourApplication>/<YourApplicationVersion> ([[https:~~/~~/www.yourdomain.com>>url:https://www.yourdomain.com/||shape="rect"]]; [[yourname@yourdomain.com>>mailto:yourname@yourdomain.com||shape="rect"]])
40 +)))|(((
41 +WordPress-Plugin/1.0 ([[https:~~/~~/www.deinblog.com>>url:https://www.deinblog.com/||shape="rect"]]; [[admin@deinblog.com>>mailto:admin@deinblog.com||shape="rect"]])
42 +)))
21 21  
22 -API v1 is based on the following technology stack:
44 +(% class="auto-cursor-target" %)
45 +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 illegetimate.
46 +)))
47 +* 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.
48 +* All REST ressources 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.
49 +* Timestamps are returned in ISO8601 format.
23 23  
24 -* **REST:** API v1 is provided as a pure [[REST (Representational State Transfer)>>http://en.wikipedia.org/wiki/Representational_State_Transfer]] API via HTTP, which means that we use for example HTTP methods, HTTP status codes and URL structures correctly to allow you to retrieve, create, update and delete data.
25 -* **XML, XSD:** For exchanging data the API uses XML as data exchanged format. The allowed lists and entities are described using [[XSD (XML Schema)>>http://en.wikipedia.org/wiki/Xsd]].
26 -* **WADL:** Our API is described using [[WADL (Web Application Description Language)>>http://en.wikipedia.org/wiki/Web_Application_Description_Language]]. Using WADL we describe which URLs the API provides, which HTTP methods can be used per URL, which HTTP status codes can be expected and what the input and output payload is. WADL can be used like WSDL to generate client code for all kinds of programming languages, such as Java.
27 -* **SVG:** We make use of [[SVG (Scalable Vector Graphics)>>http://en.wikipedia.org/wiki/Svg]] to describe product types and products, e.g. for describing print areas or design positioning and transformations.
51 += Next Steps =
28 28  
29 -**API Parts**
53 +A tutorial will be made available soon showing the use of this API in order to implement an own shop system.
30 30  
31 -API v1 consists right now of three parts as you can see in the picture above:
55 +\\
32 32  
33 -* **Data API:** Our data API allows you to retrieve, create, update and delete all kind of Spreadshirt shop and user data, e.g retrieve designs, articles, products or create and retrieve baskets. The data API is available on [[http:~~/~~/api.spreadshirt.net/api/v1/metaData/api.html>>http://api.spreadshirt.net/api/v1/metaData/api.html]].
34 -* **Image API:** Our image API allows you to retrieve all kinds of images and create, update and delete specific ones, e.g. retrieve design, product or product type images. The image API is available on [[http:~~/~~/image.spreadshirt.net/image-server/v1/metaData/image-service.html>>http://image.spreadshirt.net/image-server/v1/metaData/image-service.html]].
35 -* **Configuration Repository:** Our configuration repository allows you to store and retrieve all kinds of configurations for social network widgets, such as myspace or facebook.
57 +\\
36 36  
37 -**Existing APIs**
59 += [[doc:Legal Information]] =
38 38  
39 -API v1 will replace on the long term all APIs that exist right now, be it API v0 (which is used by our T-Shirt-Designer), our old SOAP API (which is used for a couple of integrations and widgets) or partner specific APIs. It should also used by all plugin writers, system integrators and widget developers in the future, that use legacy APIs or RSS feeds in their applications right now.
61 +(% class="auto-cursor-target" %)
62 +\\
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -819277
1 +28278905
url
... ... @@ -1,1 +1,1 @@
1 -https://developer.spreadshirt.net/wiki/spaces/API/pages/819277/Home
1 +https://developer.spreadshirt.net/wiki/spaces/API/pages/28278905/Spreadshirt Public Shop API Documentation

Navigation