Last modified by admin on 2023/02/14 14:43
<
From version < 21.1 >
edited by mbs
on 2010/04/16 12:42
To version < 59.1 >
edited by Shop Team
on 2023/02/13 22:55
>
Change comment: Renamed from xwiki:API.Spreadshirt Public Shop API Documentation

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Home
1 +Spreadshirt Public Shop API Documentation
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.mbs
1 +XWiki.shop
Content
... ... @@ -1,14 +1,66 @@
1 -The Spreadshirt API provides a programmable REST interface that gives you access to most of Spreadshirt's platform functionality. To understand what the API can do for you:
1 += Preface =
2 2  
3 -* Read [[API Explained>>API Explained]] first to understand what features the API provides today and what it will provide in the future.
4 -* Read [[API Models Explained>>API Models Explained]], to get a grip on the actual business of printing designs and text on apparel and the data models you need to understand in order to exchange data with our API [[.>>API Models Explained]]
5 -* Read [[API Basics>>API Basics]], to learn about the basics of using our API, such as used HTTP methods, used HTTP status codes and used query/header parameters.
6 -* Read [[API Resources>>API Resources]], to understand which resources are provided by the REST interface and how you can use them
3 +Spreadshirt provides several ways to offer an online shop experience to your customers and earn money through commission:
7 7  
8 -To get started using the API&nbsp;
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.spreadshop.com/hc/en-us/articles/360010529039-Website-Integration-with-JavaScript||shape="rect"]]). 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.
9 9  
10 -* Conduct API calls using your [[Web browser>>http://api.spreadshirt.net/api/v1/shops/205909]] or our [[API browser>>http://demoapp.spreadshirt.net/apibrowser/]].
11 -* [[Register for an API key>>mailto:developer@spreadshirt.net]] with your Spreadshirt user id in case you need access to special features, such as product creation, design upload or basket creation. [[Register for a Spreadshirt shop>>http://www.spreadshirt.net/open-t-shirt-shop-C5781]], in case you don't have one yet..
12 -* [[Browse sample applications>>APP:Home]] and the sample applications source code.
10 += Prerequisites =
13 13  
14 -Please note that the **Spreadshirt API is right now available as an alpha version**. That means that the Spreadshirt API, i.e. offered URLs, representations and status codes, is not stable yet and we reserve the right to conduct changes on it.
12 +Spreadshirt runs a European and a North American platform that are independent from another. You need to:
13 +
14 +* Choose a platform
15 +* Register a Spreadshop:
16 +** Europe: [[here>>url:https://www.spreadshirt.net/start-selling-C5780||shape="rect"]]
17 +** North America: [[here>>url:https://www.spreadshirt.com/start-selling-shirts-C3598||shape="rect"]]
18 +* Visit this partner area page of the appropriate platform to retrieve your API Key:
19 +** Europe: [[here>>url:https://partner.spreadshirt.net/apiKey||shape="rect"]]
20 +** North America: [[here>>url:https://partner.spreadshirt.com/apiKey||shape="rect"]]
21 +
22 += Basics =
23 +
24 +* 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.
25 +* 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"]].)
26 +* (((
27 +(% class="auto-cursor-target" %)
28 +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:
29 +
30 +|=(((
31 +Header Key
32 +)))|=(((
33 +Header Value Format
34 +)))|=(((
35 +Example Header Value
36 +)))
37 +|(((
38 +Authorization
39 +)))|(((
40 +SprdAuth apiKey="<apikey>"
41 +)))|(((
42 +SprdAuth apiKey="dd30b4db-8cd6-4fb8-86b3-e680984b9e18"
43 +)))
44 +|(((
45 +User-Agent
46 +)))|(((
47 +<YourApplication>/<YourApplicationVersion> ([[https:~~/~~/www.yourdomain.com>>url:https://www.yourdomain.com/||shape="rect"]]; [[yourname@yourdomain.com>>mailto:yourname@yourdomain.com||shape="rect"]])
48 +)))|(((
49 +WordPress-Plugin/1.0 ([[https:~~/~~/www.deinblog.com>>url:https://www.deinblog.com/||shape="rect"]]; [[admin@deinblog.com>>mailto:admin@deinblog.com||shape="rect"]])
50 +)))
51 +
52 +(% class="auto-cursor-target" %)
53 +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 illegitimate.
54 +)))
55 +* 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.
56 +* All REST 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.
57 +* Timestamps are returned in ISO8601 format.
58 +
59 += Next Steps =
60 +
61 +There is a [[tutorial>>doc:Build your own shop system]] available showing the use of this API in order to **implement an own shop system**.
62 +
63 += [[doc:Legal Information]] =
64 +
65 +(% class="auto-cursor-target" %)
66 +\\
api-parts.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +17.4 KB
Content
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3047438
1 +819217
url
... ... @@ -1,1 +1,1 @@
1 -https://developer.spreadshirt.net/wiki/spaces/API/pages/3047438/Home
1 +https://developer.spreadshirt.net/wiki/spaces/API/pages/819217/Spreadshirt Public Shop API Documentation

Navigation