Summary

• Page properties (2 modified, 0 added, 0 removed)
• Objects (1 modified, 0 added, 0 removed)
  • Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.Admin
	1	+XWiki.mbs

Content

...	...	@@ -1,39 +1,27 @@
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	+{{section}}
2	2
3		-[[api-parts.png>>image:api-parts.png||border="1" align="center"]]
	3	+{column:width=50%}
	4	+Spreadshirt is your place to create and buy customized apparel, such as T-shirts, cups or stickers. In order to allow developers to make use of this functionality in their own applications, we now provide a new Spreadshirt API. The Spreadshirt API provides access to a set of Spreadshirt's platform functionality, such as product creation, design upload or basket creation, and allows you to start building your own shops, mass-customization applications and integrations on top of our platform.
4	4
5		-**API Features**
	6	+To get started in using the Spreadshirt API:
6	6
7		-**Today**, API v1 provides the following features:
	8	+* [Browse our API documentation|API:API] to become familiar with our API, i.e. REST API urls and representations and status codes.
	9	+* Conduct API calls using your [Web browser|http://api.spreadshirt.net/api/v1/shops/205909] or our [API browser|http://demoapp.spreadshirt.net/apibrowser/].
	10	+* [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.
	11	+* [Checkout the applications section|API:Applications] to get sample code, find out what other people did with our API and get some fresh ideas.
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**.
	13	+To stay up to date on API changes and development news follow the [Spreadshirt developer blog|http://blog.spreadshirt.net/developer/].
13	13
14		-For the **next releases**, we plan to provide the following features:
	15	+Please note that *Spreadshirt API is alpha right now*. So offered URLs, representations and status codes might change until the official release.
15	15
16		-* **Design upload** and **product creation**,
17		-* **Design and article search** for marketplace and
18		-* **Better basket integration**.
	17	+{column}
	18	+{column:width=5%}
	19	+{column}
	20	+{column:width=45%}
	21	+{recently-updated}
	22	+Navigate space
	23	+{pagetreesearch}
	24	+{pagetree}
	25	+{column}
19	19
20		-**API Technology**
21		-
22		-API v1 is based on the following technology stack:
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.
28		-
29		-**API Parts**
30		-
31		-API v1 consists right now of three parts as you can see in the picture above:
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.
36		-
37		-**Existing APIs**
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.
	27	+{{/section}}

Confluence.Code.ConfluencePageClass[0]

id

...	...	@@ -1,1 +1,1 @@
1		-819277
	1	+3047456

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/3047456/Home