Navigation¶

• API Solution
  

• General
• Header
  

• Action
• Address
• Affiliate Marketing
• Article
• Customer
• Contacting
• ContactingSetting
• Edit Image
• Language
• Order
• Payment
• Portal
• Price
• PrintData
• Shipment
• ShipmentTariff
• Resale Unit
• Time Zone
• Translation
  

• All Pages
  

Search Web2Print Wiki
»

• Create a new Page
• Categories
• Administration
• File Management
  

• Create Account 
  mass customization api for brochures, t-shirts, posters, photobooks, business cards, photo products, wallpapers, shoes, sticker, surfboards and much more
    
  

General

1 General API Features¶

1.1 Security¶

All communication is done using HTTPS, so that requests and responses are encrypted.

1.2 API Key¶

In order to use the API, you need an API key. The API key is required to do any query through the API. Along with the key you'll get an API secret which has to be supplied to every request as well.

1.3 Encoding¶

The API requires all data to be UTF-8 encoded. Requests and responses can be encoded in XML or JSON.

To specify request message encoding it's required to set the HTTP-Header Content-Type to either


or


Response encoding is set using the Accept HTTP-Header


or appending a format parameter(set to either json or xml) to the current call URI query:

1.4 Formats¶

1.4.1 Boolean Format¶

Booleam values are represented by a true or false string value. All boolean values are case sensitive.

1.4.2 Number Format¶

All floating point fractions need to be separated by a decimal point ".".

Correct:

<Number>10.5</Number>

Incorrect:

<Number>10,5</Number>

1.4.3 Date Format¶

All dates are parsed and formatted according to ISO 8601. See here or here.

<DateTime>1997</DateTime> <!-- YYYY (eg 1997) -->
<DateTime>1997-07</DateTime> <!-- YYYY-MM (eg 1997-07) -->
<DateTime>1997-07-16</DateTime> <!-- YYYY-MM-DD (eg 1997-07-16) -->
<DateTime>1997-07-16T19:20+01:00</DateTime> <!-- YYYY-MM-DDThh:mmTZD (eg 1997-07-16T19:20+01:00) -->
<DateTime>1997-07-16T18:20Z</DateTime> <!-- YYYY-MM-DDThh:mmTZD (eg 1997-07-16T18:20) Universal time(Zulu) i.e. UTC -->
<DateTime>1997-07-16T19:20:30+01:00</DateTime> <!-- YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00) -->
<DateTime>1997-07-16T19:20:30.45+01:00</DateTime> <!-- YYYY-MM-DDThh:mm:ss.sTZD (eg 1997-07-16T19:20:30.45+01:00) -->

1.5 Endpoints¶

Endpoints represent URIs for different API calls. Here is an example:


The first element stands for the HTTP verb that has to be used, like GET, PUT, POST or DELETE, followed by the actual URI. Inside the URI some elements act as parameters and need to be replaced by the respective values. In this particular URI we have two parameters: PortalNamespace and CustomerGuid. These elements are always emphasized using bold text and have to be replaced prior using the URI and calling the API.

If PortalNamespace was myPortal and CustomerGuid was 4211856E-5C66-11E0-B416-2F11DFD72085 the final URI would look like this:

____________

Discussions about Web2Print SaaS Cloud API JSON REST XML:

{discussion}