Last modified by admin on 2023/02/14 14:43
<
From version < 5.1 >
edited by Admin
on 2010/03/06 16:04
To version < 15.1 >
edited by mbs
on 2010/04/16 12:17
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Admin
1 +XWiki.mbs
Content
... ... @@ -1,39 +1,14 @@
1 -Spreadshirt API is **one part of our strategy to provide Customized Apparel as a Service (CAaaS)** that I described in the General space[[http://blog.spreadshirt.net/developer/2009/11/01/customized-apparel-as-a-service-caaas/]]. Spreadshirt API is right now available in version 1 (v1).
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:
2 2  
3 -[[http:~~/~~/blog.spreadshirt.net/developer/files/2010/01/api-parts.png>>image:http://blog.spreadshirt.net/developer/files/2010/01/api-parts.png||border="1"]]
3 +* Read [[API Explained>>API:API Explained]] first to understand what features the API provides and thus what you can do with our API in the future.
4 +* Read [[API Models Explained>>API Models Explained]]section, to get a grip on the actual business of printing designs and text on apparel and the data models you need understand in order to exchange data with our API [[.>>API Models Explained]]
5 +* Read [[API Basics>>API Basics]]section, to learn about the basics for using our API, such as used HTTP methods, used HTTP status codes and used query/header parameters.
6 +* Read [[API Resources>>API Resources]] section, to understand which resources are provided by the REST interface and how you can use them
4 4  
5 -**API Features**
8 +To get started using the API&nbsp;
6 6  
7 -**Today**, API v1 provides the following features:
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.
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 -
14 -For the **next releases**, we plan to provide the following features:
15 -
16 -* **Design upload** and **product creation**,
17 -* **Design and article search** for marketplace and
18 -* **Better basket integration**.
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.
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.
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -819269
1 +1769503
url
... ... @@ -1,1 +1,1 @@
1 -https://developer.spreadshirt.net/wiki/spaces/API/pages/819269/Home
1 +https://developer.spreadshirt.net/wiki/spaces/API/pages/1769503/Home

Navigation