Notre API d'impression de produits photos personnalisables

Personnalisez votre projet et constituez un outil de communication unique pour votre marque !

Notre API vous permet d'automatiser la commande de produits photos.
Bénéficiez de son intégration facile et rapide et créez un projet qui réponde à vos problématiques, attentes & objectifs.

Avantages:

Intégration simple et rapide de notre API REST dans l'interface de votre site ou votre application
Mode Sandbox pour tester votre application avant mise en production
Librairie PHP fournie

Confiez-nous vos idées ! Notre équipe technique peut également développer, pour vous, votre projet sur mesure.

Documentation technique de l'API

URLs

All testing and development should be done against the sandbox API . This is an environment where you can create, and submit orders without incurring any costs

Sandbox API URL:

http://api-sandbox.printofoto.com/api/

Live API URL:

https://api.printofoto.com/api/

General notes

Request Format

Requests should be made using either JSON or Postdata.
The Content-type header should be set accordingly to either Content-type: application/json or application/x-www-form-urlencoded

Response Format

Please note that responses are formatted according to the accept http header. At present, we recommend that you supply an value of accept: application/json at this time.

Standard API return codes

Code	Description
`200`	OK
`201`	Created
`400`	Bad or missing input parameter- see error for more details
`403`	Forbidden. The request is not valid for the resource in its current state
`404`	Resource not found

Authentication

PRINTOFOTO.api uses custom HTTP headers for Authorization

Header	Description
api_key	Your api_key you received this when signing up
api_secret	Your api_secret you received this when signing up

All requests should include these two HTTP headers

Filtering Resources

Limit

You can limit the number of results by applying the limit filter. The default value is 10 and the maximum value is 1000.
https://api.printofoto.com/api/{object}?limit=150

Offset

You can use the offset filter to retrieve a list starting from a certain offset. The GET request below delivers 10 objects, starting with the 150th object.
https://api.printofoto.com/api/{object}?offset=150

Sort

You can sort a GET query by specifying a property name as the value of the sort filter. The default sorting is ascending. When a property name is postfixed with +DESC, the sort order is descending.
https://api.printofoto.com/api/{object}?sort=date_creation+DESC

PHP Class

You can use this class to use our API. Please edit these field in the file :

Header	Description
$apiKey	Your api_key you received this when signing up
$secretKey	Your api_secret you received this when signing up

Bookmark

api/bookmark (GET)

Description

Retrieves information about the different bookmark

Url

http://api.printofoto.com/api/bookmark

Method

GET

Parameters

date_from Only retrieve bookmark with creation_date less than the specified value.
date_to Only retrieve bookmark with creation_date after than the specified value.
custom Only retrieve bookmark with custom field equal the specified value.

Returns

JSON object containing information on any errors or warnings associated with the bookmark

Sample JSON response

[{
	"id_bookmark":"1",
	"text": "This is my bookmark",
	"image_url_1": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"logo_url": "http://api.printofoto.com/images/113/373/145/logo.jpg",
	"custom": "my_bookmark",
	date_creation: "2015-01-05 14:01:40"
},
{
	"id_bookmark":"2",
	"text": "This is my second bookmark",
	"image_url_1": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"logo_url": "",
	"custom": "my_bookmark",
	date_creation: "2015-01-05 14:01:40"
},
...
}]

Bookmark Item

Field	Description
id_bookmark	Unique Identifier of a bookmark
text	Text show at the back of the bookmark
image_url_1	An url of an image for the bookmark `(jpg\|gif\|png - 5x15cm 300dpi - 567x1795px)` You can use Image object to create a image ressource
logo_url	An url of an image to show a logo at the back of the bookmark `(jpg\|gif\|png)` `(max_width=800px,max_height=400px)` You can use Image object to create a image ressource
date_creation	The creation date for the bookmark
custom	A custom field for your use

api/bookmark (POST)

Description	Creates a new bookmark
Url	`http://api.printofoto.com/api/bookmark`
Method	POST
Parameters	`text` (optional \| String) `image_url_1` (mandatory \| Url of image resource) `logo_url` (optional \| Url of image resource) `custom` (optional \| String)
Returns	JSON object representing the new bookmark (see /Bookmark (GET) for details )
Return code	`201` - Object bookmark was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/bookmark/{id} (GET)

Description	Gets information of an existing bookmark
Url	`http://api.printofoto.com/api/bookmark/{id}`
Method	GET
Parameters	`id` Unique Identifier of a bookmark
Returns	JSON object representing the bookmark (see /Bookmark (GET) for details )
Return code	`404` - Bookmark with the specified id was not found

api/bookmark/{id} (PUT)

Description	Update a bookmark
Url	`http://api.printofoto.com/api/bookmark/{id}`
Method	PUT
Parameters	`text` (optional \| String) `image_url_1` (mandatory \| Url of image resource) `logo_url` (optional \| Url of image resource) `custom` (optional \| String)
Returns	JSON object representing the bookmark (see /Bookmark (GET) for details )
Return code	`200` - Object bookmark was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No bookmark was found

api/bookmark/{id} (DELETE)

Description	Delete a bookmark
Url	`http://api.printofoto.com/api/bookmark/{id}`
Method	DELETE
Parameters	`id` (mandatory in URL \| Integer)
Return code	`204` - No content - Object bookmark was deleted `404` - No bookmark was found

BusinessCard

api/businesscard (GET)

Description

Retrieves information about the different businesscard

Url

http://api.printofoto.com/api/businesscard

Method

GET

Parameters

date_from Only retrieve businesscard with creation_date less than the specified value.
date_to Only retrieve businesscard with creation_date after than the specified value.
custom Only retrieve businesscard with custom field equal the specified value.

Returns

JSON object containing information on any errors or warnings associated with the businesscard

Sample JSON response

[{
	"id_businesscard":"1",
	"front_image_url": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"back_image_url": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"custom": "my_businesscard",
	date_creation: "2015-04-05 14:01:40"
},
{
	"id_businesscard":"2",
	"front_image_url": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"back_image_url": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"custom": "my_businesscard",
	date_creation: "2015-04-05 14:01:42"
},
...
}]

Businesscard Item

Field	Description
id_businesscard	Unique Identifier of a businesscard
front_image_url	An url of an image for the front of the busineess card `(jpg\|gif\|png - 8.5x5.5cm 300dpi - 1004x650px)` You can use Image object to create a image ressource
back_image_url	An url of an image for the back of the busineess card `(jpg\|gif\|png- 8.5x5.5cm 300dpi - 1004x650px)` You can use Image object to create a image ressource
date_creation	The creation date for the businesscard
custom	A custom field for your use

api/businesscard (POST)

Description	Creates a new businesscard
Url	`http://api.printofoto.com/api/businesscard`
Method	POST
Parameters	`front_image_url` (mandatory \| Url of image resource) `back_image_url` (mandatory \| Url of image resource) `custom` (optional \| String)
Returns	JSON object representing the new businesscard (see /Businesscard (GET) for details )
Return code	`201` - Object businesscard was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/businesscard/{id} (GET)

Description	Gets information of an existing businesscard
Url	`http://api.printofoto.com/api/businesscard/{id}`
Method	GET
Parameters	`id` Unique Identifier of a businesscard
Returns	JSON object representing the businesscard (see /Businesscard (GET) for details )
Return code	`404` - Businesscard with the specified id was not found

api/businesscard/{id} (PUT)

Description	Update a businesscard
Url	`http://api.printofoto.com/api/businesscard/{id}`
Method	PUT
Parameters	`front_image_url` (mandatory \| Url of image resource) `back_image_url` (mandatory \| Url of image resource) `custom` (optional \| String)
Returns	JSON object representing the businesscard (see /Businesscard (GET) for details )
Return code	`200` - Object businesscard was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No businesscard was found

api/businesscard/{id} (DELETE)

Description	Delete a businesscard
Url	`http://api.printofoto.com/api/businesscard/{id}`
Method	DELETE
Parameters	`id` (mandatory in URL \| Integer)
Return code	`204` - No content - Object businesscard was deleted `404` - No businesscard was found

Calendar

api/calendar (GET)

Description

Retrieves information about the different calendar

Url

http://api.printofoto.com/api/calendar

Method

GET

Parameters

date_from Only retrieve calendar with creation_date less than the specified value.
date_to Only retrieve calendar with creation_date after than the specified value.
custom Only retrieve calendar with custom field equal the specified value.

Returns

JSON object containing information on any errors or warnings associated with the calendar

Sample JSON response

[{
	"id_calendar":"1",
	"title": "My first calendar",
	"cover_message": "Just for you!",
	"template": "2",
	"font_color": "#000000",
	"background_color": "#ffffff",
	"logo_url": "http://api.printofoto.com/images/113/373/145/logo.jpg",
	"start_date": "2014-01-01",
	"show_week_number": "0",
	"show_ephemeris": "1",
	"image_url_1": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_2": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_3": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_4": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_5": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_6": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_7": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_8": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_9": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_10": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_11": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_12": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"cover_url": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"backcover_url": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"custom": "my_calendar",
	date_creation: "2015-01-05 14:01:40"
},
{
	"id_calendar":"2",
	"title": "My second calendar",
	"cover_message": "Just for you!",
	"template": "2",
	"font_color": "#000000",
	"background_color": "#ffffff",
	"logo_url": "http://api.printofoto.com/images/113/373/145/logo.jpg",
	"start_date": "2014-01-01",
	"show_week_number": "0",
	"show_ephemeris": "1",
	"image_url_1": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_2": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_3": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_4": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_5": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_6": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_7": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_8": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_9": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_10": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_11": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_12": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"cover_url": "http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"backcover_url": "",
	"custom": "my_calendar",
	date_creation: "2015-01-05 14:01:40"
},
...
}]

Calendar Item

Field	Description
id_calendar	Unique Identifier of a calendar
title	Title show in the first page of calendar
cover_message	A message show in the first page of calendar
template	Template of the calendar
font_color	Font color for the text of the calendar
background_color	Background color of each page of the calendar
logo_url	An url of an image to show a logo at the backpage of the calendar `(jpg\|gif\|png)` `(max_width=800px,max_height=400px)` You can use Image object to create a image ressource
start_date	The start date for your calendar `2015-01`
show_week_number	Show the week number for all weeks
show_ephemeris	Show holy in the box of all days
image_url_1	An url of an image for the first month `(jpg\|gif\|png - 28x17cm 300dpi - 3307x2008px)` You can use Image object to create a image ressource
image_url_2	An url of an image for the second month `(jpg\|gif\|png - 28x17cm 300dpi - 3307x2008px)` You can use Image object to create a image ressource
image_url_3	An url of an image for the third month `(jpg\|gif\|png - 28x17cm 300dpi - 3307x2008px)` You can use Image object to create a image ressource
image_url_4	An url of an image for the fourth month `(jpg\|gif\|png - 28x17cm 300dpi - 3307x2008px)` You can use Image object to create a image ressource
image_url_5	An url of an image for the fifth month `(jpg\|gif\|png - 28x17cm 300dpi - 3307x2008px)` You can use Image object to create a image ressource
image_url_6	An url of an image for the sixth month `(jpg\|gif\|png - 28x17cm 300dpi - 3307x2008px)` You can use Image object to create a image ressource
image_url_7	An url of an image for the seventh month `(jpg\|gif\|png - 28x17cm 300dpi - 3307x2008px)` You can use Image object to create a image ressource
image_url_8	An url of an image for the eighth month `(jpg\|gif\|png - 28x17cm 300dpi - 3307x2008px)` You can use Image object to create a image ressource
image_url_9	An url of an image for the ninth month `(jpg\|gif\|png - 28x17cm 300dpi - 3307x2008px)` You can use Image object to create a image ressource
image_url_10	An url of an image for the tenth month `(jpg\|gif\|png - 28x17cm 300dpi - 3307x2008px)` You can use Image object to create a image ressource
image_url_11	An url of an image for the eleventh month `(jpg\|gif\|png - 28x17cm 300dpi - 3307x2008px)` You can use Image object to create a image ressource
image_url_12	An url of an image for the twelfth month `(jpg\|gif\|png - 28x17cm 300dpi - 3307x2008px)` You can use Image object to create a image ressource
cover_url	An url of an image showing in the cover page of the calendar `(jpg\|gif\|png - 29.7x42cm 300dpi - 3580x4961px)` You can use Image object to create a image ressource
backcover_url	An url of an image showing in the backcover page of the calendar `(jpg\|gif\|png - 29.7x42cm 300dpi - 3580x4961px)` You can use Image object to create a image ressource
date_creation	The creation date for the calendar
custom	A custom field for your use

api/calendar (POST)

Description	Creates a new calendar
Url	`http://api.printofoto.com/api/calendar`
Method	POST
Parameters	`title` (optional \| String) `cover_message` (optional \| String) `template` (mandatory \| Integer) `font_color` (mandatory \| Color:#ff00ff) `background_color` (mandatory\| Color:#ff00ff) `logo_url` (optional \| Url of image resource) `start_date` (mandatory \| Date:2015-01) `show_week_number` (mandatory \| Boolean) `show_ephemeris` (mandatory\| Boolean) `image_url_1` (mandatory \| Url of image resource) `image_url_2` (mandatory \| Url of image resource) `image_url_3` (mandatory \| Url of image resource) `image_url_4` (mandatory \| Url of image resource) `image_url_5` (mandatory \| Url of image resource) `image_url_6` (mandatory \| Url of image resource) `image_url_7` (mandatory \| Url of image resource) `image_url_8` (mandatory \| Url of image resource) `image_url_9` (mandatory \| Url of image resource) `image_url_10` (mandatory \| Url of image resource) `image_url_11` (mandatory \| Url of image resource) `image_url_12` (mandatory \| Url of image resource) `cover_url` (optional \| Url of image resource) `backcover_url` (optional \| Url of image resource) `custom` (optional \| String)
Returns	JSON object representing the new calendar (see /Calendar (GET) for details )
Return code	`201` - Object calendar was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/calendar/{id} (GET)

Description	Gets information of an existing calendar
Url	`http://api.printofoto.com/api/calendar/{id}`
Method	GET
Parameters	`id` Unique Identifier of a calendar
Returns	JSON object representing the calendar (see /Calendar (GET) for details )
Return code	`404` - Calendar with the specified id was not found

api/calendar/{id} (PUT)

Description	Update a calendar
Url	`http://api.printofoto.com/api/calendar/{id}`
Method	PUT
Parameters	`id` (mandatory in URL \| Integer) `title` (optional \| String) `cover_message` (optional \| String) `template` (mandatory \| Integer) `font_color` (mandatory \| Color:#ff00ff) `background_color` (mandatory\| Color:#ff00ff) `logo_url` (optional \| Url of image resource) `start_date` (mandatory \| Date:2015-01) `show_week_number` (mandatory \| Boolean) `show_ephemeris` (mandatory\| Boolean) `image_url_1` (mandatory \| Url of image resource) `image_url_2` (mandatory \| Url of image resource) `image_url_3` (mandatory \| Url of image resource) `image_url_4` (mandatory \| Url of image resource) `image_url_5` (mandatory \| Url of image resource) `image_url_6` (mandatory \| Url of image resource) `image_url_7` (mandatory \| Url of image resource) `image_url_8` (mandatory \| Url of image resource) `image_url_9` (mandatory \| Url of image resource) `image_url_10` (mandatory \| Url of image resource) `image_url_11` (mandatory \| Url of image resource) `image_url_12` (mandatory \| Url of image resource) `cover_url` (optional \| Url of image resource) `backcover_url` (optional \| Url of image resource) `custom` (optional \| String)
Returns	JSON object representing the calendar (see /Calendar (GET) for details )
Return code	`200` - Object calendar was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No calendar was found

api/calendar/{id} (DELETE)

Description	Delete a calendar
Url	`http://api.printofoto.com/api/calendar/{id}`
Method	DELETE
Parameters	`id` (mandatory in URL \| Integer)
Return code	`204` - No content - Object calendar was deleted `404` - No calendar was found

CalendarEvent

api/calendarevent (GET)

Description

Retrieves information about the different calendar events

Url

http://api.printofoto.com/api/calendarevent

Method

GET

Parameters

date_from Only retrieve calendar event with creation_date less than the specified value.
date_to Only retrieve calendar event with creation_date after than the specified value.
id_calendar Only retrieve calendar event from the calendar than the specified value.
date_event_from Only retrieve calendar event with date_event less than the specified value.
date_event_to Only retrieve calendar with date_event after than the specified value.

Returns

JSON object containing information on any errors or warnings associated with the calendar event

Sample JSON response

[{
	"id_calendar_event":"1",
	"id_calendar":"1",
	"date_event":"2015-01-01",
	"text":"the first day of this year",
	"image_url":"",
	"date_creation":"2015-01-05 14:11:03"
},
{
	"id_calendar_event":"2",
	"id_calendar":"1",
	"date_event":"2015-01-02",
	"text":"Anna's birthday",
	"image_url":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"date_creation":"2015-01-05 14:14:05"}
,
...
}]

Calendar Event Item

Field	Description
id_calendar_event	Unique Identifier of a calendar event
id_calendar	Unique Identifier of a calendar
date_event	The date of the event
text	Text of the event
image_url	An url of an image for the event (background of the box of the day) `(jpg\|gif\|png - 4x3.4cm 300dpi - 472x402px)` You can use Image object to create a image ressource
date_creation	The creation date for the calendar event

api/calendarevent (POST)

Description	Creates a new calendar event
Url	`http://api.printofoto.com/api/calendarevent`
Method	POST
Parameters	`id_calendar` (mandatory \| Integer \| id of calendar resource) `date_event` (mandatory \| Date:2015-01-01) `text` (mandatory \| String) `image_url` (optional \| Url of image resource)
Returns	JSON object representing the new calendar event (see /Calendarevent (GET) for details )
Return code	`201` - Object calendar event was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/calendarevent/{id} (GET)

Description	Gets information of an existing calendar event
Url	`http://api.printofoto.com/api/calendarevent/{id}`
Method	GET
Parameters	`id` Unique Identifier of a calendar event
Returns	JSON object representing the calendar event (see /Calendarevent (GET) for details )
Return code	`404` - Calendar Event with the specified id was not found

api/calendarevent/{id} (PUT)

Description	Update a calendar event
Url	`http://api.printofoto.com/api/calendarevent/{id}`
Method	PUT
Parameters	`id` (mandatory in URL \| Integer) `id_calendar` (mandatory \| Integer \| id of calendar resource) `date_event` (mandatory \| Date:2015-01-01) `text` (mandatory \| String) `image_url` (optional \| Url of image resource)
Returns	JSON object representing the calendar (see /Calendarevent (GET) for details )
Return code	`200` - Object calendar event was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No calendar event was found

api/calendarevent/{id} (DELETE)

Description	Delete a calendar
Url	`http://api.printofoto.com/api/calendarevent/{id}`
Method	DELETE
Parameters	`id` (mandatory in URL \| Integer)
Return code	`204` - No content - Object calendar event was deleted `404` - No calendar event was found

Card

api/card (GET)

Description

Retrieves information about the different cards

Url

http://api.printofoto.com/api/card

Method

GET

Parameters

date_from Only retrieve card with creation_date less than the specified value.
date_to Only retrieve card with creation_date after than the specified value.
custom Only retrieve card with custom field equal the specified value.

Returns

JSON object containing information on any errors or warnings associated with the card

Sample JSON response

[{
	"id_card":"1",
	"image_url":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_aspect_ratio":"fit"
	"logo_url":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"backcover_url":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"custom":"christmas",
	"date_creation":"2015-01-05 15:31:04"
},
{
	"id_card":"1",
	"image_url":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_aspect_ratio":"fill"
	"logo_url":"",
	"backcover_url":"",
	"custom":"christmas",
	"date_creation":"2015-01-05 15:31:04"
,
...
}]

Card Item

Field	Description
id_card	Unique Identifier of a card
image_url	An url of an image for the front of the card `(jpg\|gif\|png - 15x15cm 300dpi - 1772x1772px)` You can use Image object to create a image ressource
image_aspect_ratio	Fit or Fill `(Fit : image resize to fit the card)` `(Fill : image resize to fill the card)`
logo_url	An url of a logo for the back of the card `(jpg\|gif\|png)` You can use Image object to create a image ressource
backcover_url	An url of an image for the back of the card `(jpg\|gif\|png - 15x15cm 300dpi - 1772x1772px)` You can use Image object to create a image ressource
custom	A custom field for your use
date_creation	The creation date for the card

api/card (POST)

Description	Creates a new card
Url	`http://api.printofoto.com/api/card`
Method	POST
Parameters	`image_url` (mandatory \| Url of image resource) `image_aspect_ratio` (mandatory \| Fit or Fill) `logo_url` (optional \| Url of image resource) `backcover_url` (optional \| Url of image resource) `custom` (optional \| String)
Returns	JSON object representing the new card (see /Card (GET) for details )
Return code	`201` - Object card was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/card/{id} (GET)

Description	Gets information of an existing card
Url	`http://api.printofoto.com/api/card/{id}`
Method	GET
Parameters	`id` Unique Identifier of a card
Returns	JSON object representing the card (see /Card (GET) for details )
Return code	`404` - Card with the specified id was not found

api/card/{id} (PUT)

Description	Update a card
Url	`http://api.printofoto.com/api/card/{id}`
Method	PUT
Parameters	`id` (mandatory in URL \| Integer) `image_url` (mandatory \| Url of image resource) `image_aspect_ratio` (mandatory \| Fit or Fill) `logo_url` (optional \| Url of image resource) `backcover_url` (optional \| Url of image resource) `custom` (optional \| String)
Returns	JSON object representing the card (see /Card (GET) for details )
Return code	`200` - Object card was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No card was found

api/card/{id} (DELETE)

Description	Delete a card
Url	`http://api.printofoto.com/api/card/{id}`
Method	DELETE
Parameters	`id` (mandatory in URL \| Integer)
Return code	`204` - No content - Object card was deleted `404` - No card was found

Factsheet

api/factsheet (GET)

Description

Retrieves information about the different factsheets

Url

http://api.printofoto.com/api/factsheet

Method

GET

Parameters

date_from Only retrieve factsheet with creation_date less than the specified value.
date_to Only retrieve factsheet with creation_date after than the specified value.
custom Only retrieve factsheet with custom field equal the specified value.

Returns

JSON object containing information on any errors or warnings associated with the factsheet

Sample JSON response

[{
	"id_factsheet":"1",
	"logo_url":"http://api.printofoto.com/images/113/373/145/logo.jpg",
	"custom":"",
	"format":"148x210_by_3",
	"date_creation":"2016-07-04 16:37:30"
}
,
{
	"id_factsheet":"2",
	"logo_url":"",
	"custom":"",
	"format":"148x210_by_3",
	"date_creation":"2016-07-04 16:37:30"
}
,                
...
}]

Factsheet Item

Field	Description
id_factsheet	Unique Identifier of a factsheet
logo_url	An url of an image to show a logo `(jpg\|gif\|png)` `(max_width=800px,max_height=400px)` You can use Image object to create a image ressource
format	the format of the product \| Pack 3 fiches pratiques A5 : `148x210_by_3`
custom	A custom field for your use
date_creation	The creation date for the factsheet

api/factsheet (POST)

Description	Creates a new factsheet
Url	`http://api.printofoto.com/api/factsheet`
Method	POST
Parameters	`logo_url` (optional \| Url of image resource) `custom` (optional \| String) `format` (optional \| String)
Returns	JSON object representing the new factsheet (see /Factsheet (GET) for details )
Return code	`201` - Object factsheet detail was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/factsheet/{id} (GET)

Description	Gets information of an existing factsheet
Url	`http://api.printofoto.com/api/factsheet/{id}`
Method	GET
Parameters	`id` Unique Identifier of a factsheet
Returns	JSON object representing the factsheet (see /Factsheet (GET) for details )
Return code	`404` - Factsheet with the specified id was not found

api/factsheet/{id} (PUT)

Description	Update a factsheet
Url	`http://api.printofoto.com/api/factsheet/{id}`
Method	PUT
Parameters	`id` (mandatory in URL \| Integer) `logo_url` (optional \| Url of image resource) `custom` (optional \| String) `format` (optional \| String)
Returns	JSON object representing the factsheet (see /Factsheet (GET) for details )
Return code	`200` - Object factsheet was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No factsheet was found

api/factsheet/{id} (DELETE)

Description	Delete a factsheet
Url	`http://api.printofoto.com/api/factsheet/{id}`
Method	DELETE
Parameters	`id` (mandatory in URL \| Integer)
Return code	`204` - No content - Object factsheet was deleted `404` - No factsheet was found

FactSheetItem

api/factsheetitem (GET)

Description

Retrieves information about the different items of a factsheet

Url

http://api.printofoto.com/api/factsheetitem

Method

GET

Parameters

date_from Only retrieve factsheetitem with creation_date less than the specified value.
date_to Only retrieve factsheetitem with creation_date after than the specified value.
id_factsheet Only retrieve factsheetitem from the factsheet than the specified value.

Returns

JSON object containing information on any errors or warnings associated with the factsheet item

Sample JSON response

[{
"id_factsheet_item":"1",
"id_factsheet":"1",
"front_image_url":"http://api.printofoto.com/images/125/388/125/b36d0.jpg",
"back_image_url":"http://api.printofoto.com/images/125/388/125/b36d0.jpg",
"date_creation":"2015-01-06 16:55:52"
}
,
{
"id_factsheet_item":"2",
"id_factsheet":"1",
"front_image_url":"http://api.printofoto.com/images/125/388/125/b36d0.jpg",
"back_image_url":"http://api.printofoto.com/images/125/388/125/b36d0.jpg",
"date_creation":"2015-01-06 16:55:52"
}
,                
...
}]

FactSheet Item

Field	Description
id_factsheet_item	Unique Identifier of a factsheet item
id_factsheet	Unique Identifier of a factsheet
front_image_url	An url of an image `(jpg\|gif\|png - 21x14.8cm 300dpi or 14.8x21cm 300dpi - 2480x1748px or 1748x2480px)` You can use Image object to create a image ressource
date_creation	The creation date for the factsheet item

api/factsheetitem (POST)

Description	Creates a new factsheet item
Url	`http://api.printofoto.com/api/factsheetitem`
Method	POST
Parameters	`id_factsheet` (mandatory \| Integer) `front_image_url` (mandatory \| Url of image resource) `back_image_url` (mandatory \| Url of image resource)
Returns	JSON object representing the new factsheet item (see /FactSheetItem (GET) for details )
Return code	`201` - Object factsheet item was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/factsheetitem/{id} (GET)

Description	Gets information of an existing factsheet item
Url	`http://api.printofoto.com/api/factsheetitem/{id}`
Method	GET
Parameters	`id` Unique Identifier of a factsheet item
Returns	JSON object representing the factsheet item (see /FactSheetItem (GET) for details )
Return code	`404` - FactSheet item with the specified id was not found

api/factsheetitem/{id} (PUT)

Description	Update a factsheet item
Url	`http://api.printofoto.com/api/factsheetitem/{id}`
Method	PUT
Parameters	`id` (mandatory in URL \| Integer) `id_factsheet` (mandatory \| Integer) `front_image_url` (mandatory \| Url of image resource) `back_image_url` (mandatory \| Url of image resource)
Returns	JSON object representing the factsheet item (see /#FactSheetItem (GET) for details )
Return code	`200` - Object factsheet item was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No factsheet item was found

api/factsheetitem/{id} (DELETE)

Description	Delete a factsheet item
Url	`http://api.printofoto.com/api/factsheetitem/{id}`
Method	DELETE
Parameters	`id` (mandatory in URL \| Integer)
Return code	`204` - No content - Object factsheet item was deleted `404` - No factsheet item was found

Image

api/image (GET)

Description

Retrieves information about the different images

Url

http://api.printofoto.com/api/image

Method

GET

Parameters

date_from Only retrieve image with creation_date less than the specified value.
date_to Only retrieve image with creation_date after than the specified value.
tag Only retrieve image with tag equal the specified value.

Returns

JSON object containing information on any errors or warnings associated with the image

Sample JSON response

[{
	"id_image":"1",
	"image":"85451145.jpg",
	"name":"My dog",
	"preview_url":"http://api.printofoto.com/images/113/373/145/85451145.jpg",
	"tag":"dog,animal",
	"public":"1",
	"date_creation":"2015-01-05 16:08:22"
}
,
{
	"id_image":"2",
	"image":"b36d0.jpg",
	"name":"My cat",
	"preview_url":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"tag":"cat,animal",
	"public":"0",
	"date_creation":"2015-01-05 17:28:07"
}
,                
...
}]

Image Item

Field	Description
id_image	Unique Identifier of an image
image	Name of the image
name	Name of the image
preview_url	Url of the resource image, can be use to create photobook,calendar,postcard...
tag	tags for the image separated by a comma
public	If the image can be used for all
date_creation	The creation date for the image

api/image (POST)

Description	Creates a new image
Url	`http://api.printofoto.com/api/image`
Method	POST
Parameters	`image` (mandatory \| URL or Image file: then make this request as a multipart/form-data with the file included `name` (optional \| String) `tag` (optional \| String) `public` (mandatory \| Boolean)
Returns	JSON object representing the new calendar event (see /Image (GET) for details )
Return code	`201` - Object image was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/image/{id} (GET)

Description	Gets information of an existing image
Url	`http://api.printofoto.com/api/image/{id}`
Method	GET
Parameters	`id` Unique Identifier of an image
Returns	JSON object representing the image (see /Image (GET) for details )
Return code	`404` - Image with the specified id was not found

api/image/{id} (PUT)

Description	Update a image
Url	`http://api.printofoto.com/api/image/{id}`
Method	PUT
Parameters	`id` (mandatory in URL \| Integer) `image` (mandatory \| URL or Image file:then make this request as a multipart/form-data with the file included) `name` (optional \| String) `tag` (optional \| String) `public` (mandatory \| Boolean)
Returns	JSON object representing the image (see /Image (GET) for details )
Return code	`200` - Object image event was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No image event was found

api/image/{id} (DELETE)

Description	Delete a image
Url	`http://api.printofoto.com/api/image/{id}`
Method	DELETE
Parameters	`id` (mandatory in URL \| Integer)
Return code	`204` - No content - Object image was deleted `404` - No image event was found

Magnet

api/magnet (GET)

Description

Retrieves information about the different magnets

Url

http://api.printofoto.com/api/magnet

Method

GET

Parameters

date_from Only retrieve magnet with creation_date less than the specified value.
date_to Only retrieve magnet with creation_date after than the specified value.
custom Only retrieve magnet with custom field equal the specified value.

Returns

JSON object containing information on any errors or warnings associated with the magnet

Sample JSON response

[{
	"id_magnet":"1",
	"image_url":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"custom":"christmas",
	"date_creation":"2015-01-05 15:31:04",
	"format":"50x50"
},
{
	"id_magnet":"2",
	"image_url":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"custom":"dogs",
	"date_creation":"2015-01-05 15:31:04",
	"format":"70x70"
,
...
}]

Magnet Item

Field	Description
id_magnet	Unique Identifier of a magnet
image_url	An url of an image for the magnet `(jpg\|gif\|png - picture size depending size of magnet)` You can use Image object to create a image ressource
custom	A custom field for your use
date_creation	The creation date for the card
Format	The format of the magnet (mm) `50x50` (mm) `60x60` (mm) `70x70` (mm) `80x80` (mm)

api/magnet (POST)

Description	Creates a new magnet
Url	`http://api.printofoto.com/api/magnet`
Method	POST
Parameters	`image_url` (mandatory \| Url of image resource) `format` (mandatory \| Format) `custom` (optional \| String)
Returns	JSON object representing the new magnet (see /Magnet (GET) for details )
Return code	`201` - Object magnet was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/magnet/{id} (GET)

Description	Gets information of an existing magnet
Url	`http://api.printofoto.com/api/magnet/{id}`
Method	GET
Parameters	`id` Unique Identifier of a magnet
Returns	JSON object representing the magnet (see /Magnet (GET) for details )
Return code	`404` - Magnet with the specified id was not found

api/magnet/{id} (PUT)

Description	Update a magnet
Url	`http://api.printofoto.com/api/magnet/{id}`
Method	PUT
Parameters	`id` (mandatory in URL \| Integer) `image_url` (mandatory \| Url of image resource) `format` (mandatory \| Format) `custom` (optional \| String)
Returns	JSON object representing the magnet (see /Magnet (GET) for details )
Return code	`200` - Object magnet was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No magnet was found

api/magnet/{id} (DELETE)

Description	Delete a magnet
Url	`http://api.printofoto.com/api/magnet/{id}`
Method	DELETE
Parameters	`id` (mandatory in URL \| Integer)
Return code	`204` - No content - Object magnet was deleted `404` - No magnet was found

MagnetGrid

api/magnetgrid (GET)

Description

Retrieves information about the different magnetgrids

Url

http://api.printofoto.com/api/magnetgrid

Method

GET

Parameters

date_from Only retrieve magnetgrid with creation_date less than the specified value.
date_to Only retrieve magnetgrid with creation_date after than the specified value.
custom Only retrieve magnetgrid with custom field equal the specified value.

Returns

JSON object containing information on any errors or warnings associated with the magnet

Sample JSON response

[{
	"id_magnetgrid":"1",
	"image_url_1":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_2":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_3":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_4":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_5":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_6":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_7":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_8":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_9":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"custom":"christmas",
	"date_creation":"2015-01-05 15:31:04",
},
{
	"id_magnetgrid":"2",
	"image_url_1":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_2":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_3":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_4":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_5":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_6":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_7":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_8":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_9":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"custom":"dogs",
	"date_creation":"2015-01-05 15:31:04",
,
...
}]

MagnetGrid Item

Field	Description
id_magnetgrid	Unique Identifier of a magnetgrid
image_url_1	An url of an image for the magnet `(jpg\|gif\|png - 5x5cm 300dpi - 591x591px)` You can use Image object to create a image ressource
image_url_2	An url of an image for the magnet `(jpg\|gif\|png - 5x5cm 300dpi - 591x591px)` You can use Image object to create a image ressource
image_url_3	An url of an image for the magnet `(jpg\|gif\|png - 5x5cm 300dpi - 591x591px)` You can use Image object to create a image ressource
image_url_4	An url of an image for the magnet `(jpg\|gif\|png - 5x5cm 300dpi - 591x591px)` You can use Image object to create a image ressource
image_url_5	An url of an image for the magnet `(jpg\|gif\|png - 5x5cm 300dpi - 591x591px)` You can use Image object to create a image ressource
image_url_6	An url of an image for the magnet `(jpg\|gif\|png - 5x5cm 300dpi - 591x591px)` You can use Image object to create a image ressource
image_url_7	An url of an image for the magnet `(jpg\|gif\|png - 5x5cm 300dpi - 591x591px)` You can use Image object to create a image ressource
image_url_8	An url of an image for the magnet `(jpg\|gif\|png - 5x5cm 300dpi - 591x591px)` You can use Image object to create a image ressource
image_url_9	An url of an image for the magnet `(jpg\|gif\|png - 5x5cm 300dpi - 591x591px)` You can use Image object to create a image ressource
custom	A custom field for your use
date_creation	The creation date for the card

api/magnetgrid (POST)

Description	Creates a new magnetgrid
Url	`http://api.printofoto.com/api/magnetgrid`
Method	POST
Parameters	`image_url_1` (mandatory \| Url of image resource) `image_url_2` (mandatory \| Url of image resource) `image_url_3` (mandatory \| Url of image resource) `image_url_4` (mandatory \| Url of image resource) `image_url_5` (mandatory \| Url of image resource) `image_url_6` (mandatory \| Url of image resource) `image_url_7` (mandatory \| Url of image resource) `image_url_8` (mandatory \| Url of image resource) `image_url_9` (mandatory \| Url of image resource) `custom` (optional \| String)
Returns	JSON object representing the new magnetgrid (see /MagnetGrid (GET) for details )
Return code	`201` - Object magnetgrid was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/magnetgrid/{id} (GET)

Description	Gets information of an existing magnetgrid
Url	`http://api.printofoto.com/api/magnetgrid/{id}`
Method	GET
Parameters	`id` Unique Identifier of a magnetgrid
Returns	JSON object representing the magnetgrid (see /MagnetGrid (GET) for details )
Return code	`404` - MagnetGrid with the specified id was not found

api/magnetgrid/{id} (PUT)

Description	Update a magnetgrid
Url	`http://api.printofoto.com/api/magnetgrid/{id}`
Method	PUT
Parameters	`image_url_1` (mandatory \| Url of image resource) `image_url_2` (mandatory \| Url of image resource) `image_url_3` (mandatory \| Url of image resource) `image_url_4` (mandatory \| Url of image resource) `image_url_5` (mandatory \| Url of image resource) `image_url_6` (mandatory \| Url of image resource) `image_url_7` (mandatory \| Url of image resource) `image_url_8` (mandatory \| Url of image resource) `image_url_9` (mandatory \| Url of image resource) `custom` (optional \| String)
Returns	JSON object representing the magnetgrid (see /MagnetGrid (GET) for details )
Return code	`200` - Object magnetgrid was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No magnetgrid was found

api/magnetgrid/{id} (DELETE)

Description	Delete a magnetgrid
Url	`http://api.printofoto.com/api/magnetgrid/{id}`
Method	DELETE
Parameters	`id` (mandatory in URL \| Integer)
Return code	`204` - No content - Object magnetgrid was deleted `404` - No magnetgrid was found

Notebook

api/notebook (GET)

Description

Retrieves information about the different notebooks

Url

http://api.printofoto.com/api/notebook

Method

GET

Parameters

date_from Only retrieve notebook with creation_date less than the specified value.
date_to Only retrieve notebook with creation_date after than the specified value.
custom Only retrieve notebook with custom field equal the specified value.

Returns

JSON object containing information on any errors or warnings associated with the notebook

Sample JSON response

[{
	"id_notebook":"1",
	"image_cover":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_backcover":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_cover_inside":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_backcover_inside":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"custom":"christmas",
	"date_creation":"2015-01-05 15:31:04",
	"format":"110x150"
},
{
	"id_notebook":"2",
	"image_cover":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_backcover":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_cover_inside":"",
	"image_backcover_inside":"",
	"custom":"christmas",
	"date_creation":"2015-01-05 15:31:04",
	"format":"110x150"
,
...
}]

Notebook Item

Field	Description
id_notebook	Unique Identifier of a notebook
image_cover	An url of an image for the notebook `(jpg\|gif\|png - 11x15cm 300dpi - 1299x1772px)` You can use Image object to create a image ressource
image_backcover	An url of an image for the notebook `(jpg\|gif\|png - 11x15cm 300dpi - 1299x1772px)` You can use Image object to create a image ressource
image_cover_inside	An url of an image for the notebook `(jpg\|gif\|png - 11x15cm 300dpi - 1299x1772px)` You can use Image object to create a image ressource
image_backcover_inside	An url of an image for the notebook `(jpg\|gif\|png - 11x15cm 300dpi - 1299x1772px)` You can use Image object to create a image ressource
custom	A custom field for your use
date_creation	The creation date for the notebook

api/notebook (POST)

Description	Creates a new notebook
Url	`http://api.printofoto.com/api/notebook`
Method	POST
Parameters	`image_cover` (mandatory \| Url of image resource) `image_backcover` (mandatory \| Url of image resource) `image_cover_inside` (optional \| Url of image resource) `image_backcover_inside` (optional \| Url of image resource) `custom` (optional \| String)
Returns	JSON object representing the new notebook (see /Notebook (GET) for details )
Return code	`201` - Object notebook was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/notebook/{id} (GET)

Description	Gets information of an existing notebook
Url	`http://api.printofoto.com/api/notebook/{id}`
Method	GET
Parameters	`id` Unique Identifier of a notebook
Returns	JSON object representing the notebook (see /Notebook (GET) for details )
Return code	`404` - Notebook with the specified id was not found

api/notebook/{id} (PUT)

Description	Update a notebook
Url	`http://api.printofoto.com/api/notebook/{id}`
Method	PUT
Parameters	`id` (mandatory in URL \| Integer) `image_cover` (mandatory \| Url of image resource) `image_backcover` (mandatory \| Url of image resource) `image_cover_inside` (optional \| Url of image resource) `image_backcover_inside` (optional \| Url of image resource) `custom` (optional \| String)
Returns	JSON object representing the notebook (see /Notebook (GET) for details )
Return code	`200` - Object notebook was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No notebook was found

api/notebook/{id} (DELETE)

Description	Delete a notebook
Url	`http://api.printofoto.com/api/notebook/{id}`
Method	DELETE
Parameters	`id` (mandatory in URL \| Integer)
Return code	`204` - No content - Object notebook was deleted `404` - No notebook was found

Order

api/order (GET)

Description

Retrieves information about the different orders

Url

http://api.printofoto.com/api/order

Method

GET

Parameters

date_from Only retrieve order with creation_date less than the specified value.
date_to Only retrieve order with creation_date after than the specified value.
id_order_partner Only retrieve order with id_order_partner equal the specified value.
order_state Only retrieve order with order_state equal the specified value.

Returns

JSON object containing information on any errors or warnings associated with the order

Sample JSON response

[{
"id_order":"1",
"id_order_partner":"ORDER99421",
"order_state":"0",
"shipping_firstname":"Jean",
"shipping_name":"Dupond",
"shipping_email":"jean.dupond@printofoto.com",
"shipping_company":"",
"shipping_address_1":"12 rue du stade",
"shipping_address_2":"Bat A1",
"shipping_zipcode":"75001",
"shipping_city":"Paris",
"shipping_country":"France",
"date_creation":"2015-01-06 15:15:37"
}
,
{
"id_order":"2",
"id_order_partner":"ORDER99455",
"order_state":"1",
"shipping_firstname":"Jean",
"shipping_name":"Dupond",
"shipping_email":"jean.dupond@printofoto.com",
"shipping_company":"My worldwide company",
"shipping_address_1":"12 rue du stade",
"shipping_address_2":"Bat A1",
"shipping_zipcode":"75001",
"shipping_city":"Paris",
"shipping_country":"France",
"date_creation":"2015-01-06 15:16:02"
}
,                
...
}]

Order Item

Field	Description
id_order	Unique Identifier of an order
id_order_partner	The identifier from your order
order_state	The state of your order `0` creation order `1` validated order `2` awaiting print order (no editable) `3` printed order (no editable) `4` shipped order (no editable) `5` delivered order (no editable) `6` canceled order
shipping_firstname	The firstname who the order should be addressed
shipping_name	The name who the order should be addressed
shipping_email	The email address who the order should be addressed
shipping_company	The name of the company who the order should be addressed
shipping_address_1	1st line of address who the order should be addressed
shipping_address_2	2nd line of address who the order should be addressed
shipping_zipcode	The zipcode who the order should be addressed
shipping_city	The city who the order should be addressed
shipping_country	The country who the order should be addressed
date_creation	The creation date for the order

api/order (POST)

Description	Creates a new order
Url	`http://api.printofoto.com/api/order`
Method	POST
Parameters	`id_order_partner` (mandatory \| String) `order_state` (optional \| Int) `shipping_firstname` (mandatory \| String) `shipping_name` (mandatory \| String) `shipping_email` (optional \| String) `shipping_company` (optional \| String) `shipping_address_1` (mandatory \| String) `shipping_address_2` (optional \| String) `shipping_zipcode` (mandatory \| String) `shipping_city` (mandatory \| String) `shipping_country` (mandatory \| String)
Returns	JSON object representing the new order (see /Order (GET) for details )
Return code	`201` - Object order was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/order/{id} (GET)

Description	Gets information of an existing order
Url	`http://api.printofoto.com/api/order/{id}`
Method	GET
Parameters	`id` Unique Identifier of an order
Returns	JSON object representing the order (see /Order (GET) for details )
Return code	`404` - Order with the specified id was not found

api/order/{id} (PUT)

Description	Update an order
Url	`http://api.printofoto.com/api/order/{id}`
Method	PUT
Parameters	`id` (mandatory in URL \| Integer) `id_order_partner` (mandatory \| String) `order_state` (optional \| Int) `shipping_firstname` (mandatory \| String) `shipping_name` (mandatory \| String) `shipping_email` (optional \| String) `shipping_company` (optional \| String) `shipping_address_1` (mandatory \| String) `shipping_address_2` (optional \| String) `shipping_zipcode` (mandatory \| String) `shipping_city` (mandatory \| String) `shipping_country` (mandatory \| String)
Returns	JSON object representing the order (see /Order (GET) for details )
Return code	`200` - Object order event was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No order event was found

OrderDetail

api/orderdetail (GET)

Description

Retrieves information about the different details of an order

Url

http://api.printofoto.com/api/orderdetail

Method

GET

Parameters

date_from Only retrieve order with creation_date less than the specified value.
date_to Only retrieve order with creation_date after than the specified value.
id_order Only retrieve order's details with id_order equal the specified value.
shipping_date_update_from Only retrieve order with shipping_date_update less than the specified value.
shipping_date_update_to Only retrieve order with shipping_date_update after than the specified value.

Returns

JSON object containing information on any errors or warnings associated with the order detail

Sample JSON response

[{
	"id_order_detail":"1",
	"id_order":"1",
	"id_product":"1",
	"id_custom":"2",
	"price":"8.5",
	"shipping_type":"normal",
	"shipping_state":"0",
	"shipping_tracking_url":"",
	"shipping_date_update":"0000-00-00 00:00:00",
	"date_creation":"2015-01-06 15:45:12"
}
,
{
	"id_order_detail":"2",
	"id_order":"1",
	"id_product":"2",
	"id_custom":"1",
	"price":"25",
	"shipping_type":"express",
	"shipping_state":"0",
	"shipping_tracking_url":"",
	"shipping_date_update":"0000-00-00 00:00:00",
	"date_creation":"2015-01-06 15:46:47"
}
,                
...
}]

Order Detail Item

Field	Description
id_order_detail	Unique Identifier of an order detail
id_order	The identifier of your order
id_product	The identifier of a product 1 : photobook 2 : calendar 3 : postcard 4 : bookmark 5 : card 6 : magnet 7 : magnetgrid 8 : mug 9 : notebook 10 : stickergrid 11 : label 12 : businesscard 13 : photoalbum 14 : poster 15 : polaroidbox 16 : unitphotoprint 17 : photoprint 18 : tshirt 19 : puzzle 20 : factsheet
id_custom	The identifier of your customization (it could be the unique id of a photobook,calendar,postcard... describe at the field id_product)
price	Selling price of the product on your website
shipping_type	The rapidity of the delivery (normal OR express)
shipping_state	The state of the shipping `0` not shipped `1` shipped
shipping_tracking_url	The tracking url
shipping_date_update	The date that changing state
date_creation	The creation date for the order detail

api/orderdetail (POST)

Description	Creates a new order detail
Url	`http://api.printofoto.com/api/orderdetail`
Method	POST
Parameters	`id_order` (mandatory \| Integer) `id_product` (mandatory \| Integer) `id_custom` (mandatory \| Integer) `shipping_type` (mandatory \| normal OR express)
Returns	JSON object representing the new order detail (see /Orderdetail (GET) for details )
Return code	`201` - Object order detail was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/orderdetail/{id} (GET)

Description	Gets information of an existing order detail
Url	`http://api.printofoto.com/api/orderdetail/{id}`
Method	GET
Parameters	`id` Unique Identifier of an order detail
Returns	JSON object representing the order detail (see /Orderdetail (GET) for details )
Return code	`404` - Order detail with the specified id was not found

api/orderdetail/{id} (PUT)

Description	Update an order detail
Url	`http://api.printofoto.com/api/orderdetail/{id}`
Method	PUT
Parameters	`id` (mandatory in URL \| Integer) `id_order` (mandatory \| Integer) `id_product` (mandatory \| Integer) `id_custom` (mandatory \| Integer) `price` (mandatory \| Float) `shipping_type` (mandatory \| normal OR express)
Returns	JSON object representing the order (see /Orderdetail (GET) for details )
Return code	`200` - Object order detail event was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No order detail event was found

Photobook

api/photobook (GET)

Description

Retrieves information about the different photobooks

Url

http://api.printofoto.com/api/photobook

Method

GET

Parameters

date_from Only retrieve photobook with creation_date less than the specified value.
date_to Only retrieve photobook with creation_date after than the specified value.
custom Only retrieve photobook with custom field equal the specified value.

Returns

JSON object containing information on any errors or warnings associated with the photobook

Sample JSON response

[{
	"id_photobook":"1",
	"template":"1",
	"title":"My first album",
	"show_cover_title":"0",
	"logo_url":"http://api.printofoto.com/images/113/373/145/logo.jpg",
	"backcover_message":"Just for you!",
	"cover_url":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"custom":"album",
	"date_creation":"2015-01-06 16:37:30"
}
,
{
	"id_photobook":"2",
	"template":"1",
	"title":"My second album",
	"show_cover_title":"1",
	"logo_url":"",
	"backcover_message":"",
	"cover_url":"",
	"custom":"",
	"date_creation":"2015-01-06 16:37:43"
}
,                
...
}]

Photobook Item

Field	Description
id_photobook	Unique Identifier of a photobook
template	Template of the photobook
title	The title of the photobook (can be show at the cover with show_cover_title field)
show_cover_title	Show the title on the cover page
logo_url	An url of an image to show a logo at the backpage of the photobook `(jpg\|gif\|png)` `(max_width=800px,max_height=400px)` You can use Image object to create a image ressource
backcover_message	A message printed at the backcover page
cover_url	An url of an image for the cover photobook (if empty, it automatically print a mosaic of your photopage) `(jpg\|gif\|png)` You can use Image object to create a image ressource
backcover_url	An url of an image for the backcover photobook (if empty, it automatically print logo or message) `(jpg\|gif\|png)` You can use Image object to create a image ressource
custom	A custom field for your use
date_creation	The creation date for the photobook

api/photobook (POST)

Description	Creates a new photobook
Url	`http://api.printofoto.com/api/photobook`
Method	POST
Parameters	`template` (mandatory \| Integer) `title` (optional \| String) `show_cover_title` (mandatory \| Boolean) `logo_url` (optional \| Url of image resource) `backcover_message` (optional \| String) `cover_url` (optional \| Url of image resource) `backcover_url` (optional \| Url of image resource) `custom` (optional \| String)
Returns	JSON object representing the new photobook (see /Photobook (GET) for details )
Return code	`201` - Object photobook detail was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/photobook/{id} (GET)

Description	Gets information of an existing photobook
Url	`http://api.printofoto.com/api/photobook/{id}`
Method	GET
Parameters	`id` Unique Identifier of a photobook
Returns	JSON object representing the photobook (see /Photobook (GET) for details )
Return code	`404` - Photobook with the specified id was not found

api/photobook/{id} (PUT)

Description	Update a photobook
Url	`http://api.printofoto.com/api/photobook/{id}`
Method	PUT
Parameters	`id` (mandatory in URL \| Integer) `template` (mandatory \| Integer) `title` (optional \| String) `show_cover_title` (mandatory \| Boolean) `logo_url` (optional \| Url of image resource) `backcover_message` (optional \| String) `cover_url` (optional \| Url of image resource) `custom` (optional \| String)
Returns	JSON object representing the photobook (see /Photobook (GET) for details )
Return code	`200` - Object photobook was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No photobook was found

api/photobook/{id} (DELETE)

Description	Delete a photobook
Url	`http://api.printofoto.com/api/photobook/{id}`
Method	DELETE
Parameters	`id` (mandatory in URL \| Integer)
Return code	`204` - No content - Object photobook was deleted `404` - No photobook was found

PhotobookPage

api/photobookpage (GET)

Description

Retrieves information about the different pages of a photobook

Url

http://api.printofoto.com/api/photobookpage

Method

GET

Parameters

date_from Only retrieve photobook with creation_date less than the specified value.
date_to Only retrieve photobook with creation_date after than the specified value.
id_photobook Only retrieve pages from the photobook than the specified value.

Returns

JSON object containing information on any errors or warnings associated with the photobook page

Sample JSON response

[{
"id_photobook_page":"1",
"id_photobook":"1",
"image_url":"http://api.printofoto.com/images/125/388/125/b36d0.jpg",
"image_aspect_ratio":"fit",
"position":"1",
"date_creation":"2015-01-06 16:55:52"
}
,
{
"id_photobook_page":"2",
"id_photobook":"1",
"image_url":"http://api.printofoto.com/images/113/373/145/b36d0ds.jpg",
"image_aspect_ratio":"fill",
"position":"2",
"date_creation":"2015-01-06 16:56:08"
}
,                
...
}]

PhotobookPage Item

Field	Description
id_photobook_page	Unique Identifier of a photobook page
id_photobook	Unique Identifier of a photobook
image_url	An url of an image `(jpg\|gif\|png - 15x15cm 300dpi - 1772x1772px)` You can use Image object to create a image ressource
image_aspect_ratio	Fit or Fill `(Fit : image resize to fit the page)` `(Fill : image resize to fill the page)`
position	The position of the page in the photobook (1 to 10)
date_creation	The creation date for the photobook

api/photobookpage (POST)

Description	Creates a new photobook page
Url	`http://api.printofoto.com/api/photobookpage`
Method	POST
Parameters	`id_photobook` (mandatory \| Integer) `image_url` (mandatory \| Url of image resource) `image_aspect_ratio` (mandatory \| Fit or Fill) `position` (mandatory \| Integer)
Returns	JSON object representing the new photobook page (see /PhotobookPage (GET) for details )
Return code	`201` - Object photobook page was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/photobookpage/{id} (GET)

Description	Gets information of an existing photobook page
Url	`http://api.printofoto.com/api/photobookpage/{id}`
Method	GET
Parameters	`id` Unique Identifier of a photobook page
Returns	JSON object representing the photobook page (see /PhotobookPage (GET) for details )
Return code	`404` - Photobook page with the specified id was not found

api/photobookpage/{id} (PUT)

Description	Update a photobook page
Url	`http://api.printofoto.com/api/photobookpage/{id}`
Method	PUT
Parameters	`id` (mandatory in URL \| Integer) `id_photobook` (mandatory \| Integer) `image_url` (mandatory \| Url of image resource) `image_aspect_ratio` (mandatory \| Fit or Fill) `position` (mandatory \| Integer)
Returns	JSON object representing the photobook page (see /PhotobookPage (GET) for details )
Return code	`200` - Object photobook page was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No photobook page was found

api/photobookpage/{id} (DELETE)

Description	Delete a photobook page
Url	`http://api.printofoto.com/api/photobookpage/{id}`
Method	DELETE
Parameters	`id` (mandatory in URL \| Integer)
Return code	`204` - No content - Object photobook page was deleted `404` - No photobook page was found

Photoprint

api/photoprint (GET)

Description

Retrieves information about the different photoprints

Url

http://api.printofoto.com/api/photoprint

Method

GET

Parameters

date_from Only retrieve photoprint with creation_date less than the specified value.
date_to Only retrieve photoprint with creation_date after than the specified value.
custom Only retrieve photoprint with custom field equal the specified value.

Returns

JSON object containing information on any errors or warnings associated with the photoprint

Sample JSON response

[{
	"id_photoprint":"1",
	"logo_url":"http://api.printofoto.com/images/113/373/145/logo.jpg",
	"message":"Just for you!",
	"custom":"",
	"format":"11x15_by_5",
	"date_creation":"2015-01-06 16:37:30"
}
,
{
	"id_photoprint":"1",
	"logo_url":"http://api.printofoto.com/images/113/373/145/logo.jpg",
	"message":"Happy birthday",
	"custom":"",
	"format":"11x15_by_20",
	"date_creation":"2015-01-06 16:37:30"
}
,                
...
}]

Photoprint Item

Field	Description
id_photoprint	Unique Identifier of a photoprint
logo_url	An url of an image to show a logo on an additionnal photo `(jpg\|gif\|png)` `(max_width=800px,max_height=400px)` You can use Image object to create a image ressource
message	A message printed on an additionnal photo
format	the format of the product \| Pack 5 photos 11x15cm : `11x15_by_5`, Pack 20 photos 11x15cm : `11x15_by_20`
custom	A custom field for your use
date_creation	The creation date for the photoprint

api/photoprint (POST)

Description	Creates a new photoprint
Url	`http://api.printofoto.com/api/photoprint`
Method	POST
Parameters	`logo_url` (optional \| Url of image resource) `message` (optional \| String) `custom` (optional \| String) `format` (optional \| String)
Returns	JSON object representing the new photoprint (see /Photoprint (GET) for details )
Return code	`201` - Object photoprint detail was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/photoprint/{id} (GET)

Description	Gets information of an existing photoprint
Url	`http://api.printofoto.com/api/photoprint/{id}`
Method	GET
Parameters	`id` Unique Identifier of a photoprint
Returns	JSON object representing the photoprint (see /Photoprint (GET) for details )
Return code	`404` - Photoprint with the specified id was not found

api/photoprint/{id} (PUT)

Description	Update a photoprint
Url	`http://api.printofoto.com/api/photoprint/{id}`
Method	PUT
Parameters	`id` (mandatory in URL \| Integer) `logo_url` (optional \| Url of image resource) `message` (optional \| String) `custom` (optional \| String) `format` (optional \| String)
Returns	JSON object representing the photoprint (see /Photoprint (GET) for details )
Return code	`200` - Object photoprint was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No photoprint was found

api/photoprint/{id} (DELETE)

Description	Delete a photoprint
Url	`http://api.printofoto.com/api/photoprint/{id}`
Method	DELETE
Parameters	`id` (mandatory in URL \| Integer)
Return code	`204` - No content - Object photoprint was deleted `404` - No photoprint was found

PhotoprintItem

api/photoprintitem (GET)

Description

Retrieves information about the different photos of a photoprint

Url

http://api.printofoto.com/api/photoprintitem

Method

GET

Parameters

date_from Only retrieve photoprintitem with creation_date less than the specified value.
date_to Only retrieve photoprintitem with creation_date after than the specified value.
id_photoprint Only retrieve photoprintitem from the photoprint than the specified value.

Returns

JSON object containing information on any errors or warnings associated with the photoprint item

Sample JSON response

[{
"id_photoprint_item":"1",
"id_photoprint":"1",
"image_url":"http://api.printofoto.com/images/125/388/125/b36d0.jpg",
"date_creation":"2015-01-06 16:55:52"
}
,
{
"id_photoprint_item":"2",
"id_photoprint":"1",
"image_url":"http://api.printofoto.com/images/125/388/125/b36d0.jpg",
"date_creation":"2015-01-06 16:55:52"
}
,                
...
}]

Photoprint Item

Field	Description
id_photoprint_item	Unique Identifier of a photoprint item
id_photoprint	Unique Identifier of a photoprint
image_url	An url of an image `(jpg\|gif\|png - 15x11cm or 11x15cm 300dpi - 1772x1299px or 1299x1772px)` You can use Image object to create a image ressource
date_creation	The creation date for the photoprint

api/photoprintitem (POST)

Description	Creates a new photoprint item
Url	`http://api.printofoto.com/api/photoprintitem`
Method	POST
Parameters	`id_photoprint` (mandatory \| Integer) `image_url` (mandatory \| Url of image resource)
Returns	JSON object representing the new photoprint item (see /PhotoprintItem (GET) for details )
Return code	`201` - Object photoprint item was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/photoprintitem/{id} (GET)

Description	Gets information of an existing photoprint item
Url	`http://api.printofoto.com/api/photoprintitem/{id}`
Method	GET
Parameters	`id` Unique Identifier of a photoprint item
Returns	JSON object representing the photoprint item (see /PhotoprintItem (GET) for details )
Return code	`404` - Photoprint item with the specified id was not found

api/photoprintitem/{id} (PUT)

Description	Update a photoprint item
Url	`http://api.printofoto.com/api/photoprintitem/{id}`
Method	PUT
Parameters	`id` (mandatory in URL \| Integer) `id_photoprint` (mandatory \| Integer) `image_url` (mandatory \| Url of image resource)
Returns	JSON object representing the photoprint item (see /PhotoprintItem (GET) for details )
Return code	`200` - Object photoprint item was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No photoprint item was found

api/photoprintitem/{id} (DELETE)

Description	Delete a photoprint item
Url	`http://api.printofoto.com/api/photoprintitem/{id}`
Method	DELETE
Parameters	`id` (mandatory in URL \| Integer)
Return code	`204` - No content - Object photoprint item was deleted `404` - No photoprint item was found

PolaroidBox

api/polaroidbox (GET)

Description

Retrieves information about the different polaroidbox

Url

http://api.printofoto.com/api/polaroidbox

Method

GET

Parameters

date_from Only retrieve polaroidbox with creation_date less than the specified value.
date_to Only retrieve polaroidbox with creation_date after than the specified value.
custom Only retrieve polaroidbox with custom field equal the specified value.

Returns

JSON object containing information on any errors or warnings associated with the polaroidbox

Sample JSON response

[{
	"id_polaroidbox":"1",
	"image_url_1":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_2":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_3":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_4":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_5":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_6":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_7":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_8":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_9":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_10":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_11":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_12":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"message":"De beaux souvenirs de vacances",
	"custom":"",
	"date_creation":"2015-01-05 15:31:04",
},
{
	"id_polaroidbox":"2",
	"image_url_1":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_2":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_3":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_4":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_5":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_6":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_7":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_8":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_9":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_10":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_11":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_12":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"custom":"",
	"date_creation":"2015-01-05 15:31:04",
,
...
}]

PolaroidBox Item

Field	Description
id_polaroidbox	Unique Identifier of a polaroidbox
image_url_1	An url of an image (full size) for the polaroid `(jpg\|gif\|png) Recommended size : 1051x1205px (89x102mm)` You can use Image object to create a image ressource
image_url_2	An url of an image (full size) for the polaroid `(jpg\|gif\|png) Recommended size : 1051x1205px (89x102mm)` You can use Image object to create a image ressource
image_url_3	An url of an image (full size) for the polaroid `(jpg\|gif\|png) Recommended size : 1051x1205px (89x102mm)` You can use Image object to create a image ressource
image_url_4	An url of an image (full size) for the polaroid `(jpg\|gif\|png) Recommended size : 1051x1205px (89x102mm)` You can use Image object to create a image ressource
image_url_5	An url of an image (full size) for the polaroid `(jpg\|gif\|png) Recommended size : 1051x1205px (89x102mm)` You can use Image object to create a image ressource
image_url_6	An url of an image (full size) for the polaroid `(jpg\|gif\|png) Recommended size : 1051x1205px (89x102mm)` You can use Image object to create a image ressource
image_url_7	An url of an image (full size) for the polaroid `(jpg\|gif\|png) Recommended size : 1051x1205px (89x102mm)` You can use Image object to create a image ressource
image_url_8	An url of an image (full size) for the polaroid `(jpg\|gif\|png) Recommended size : 1051x1205px (89x102mm)` You can use Image object to create a image ressource
image_url_9	An url of an image (full size) for the polaroid `(jpg\|gif\|png) Recommended size : 1051x1205px (89x102mm)` You can use Image object to create a image ressource
image_url_10	An url of an image (full size) for the polaroid `(jpg\|gif\|png) Recommended size : 1051x1205px (89x102mm)` You can use Image object to create a image ressource
image_url_11	An url of an image (full size) for the polaroid `(jpg\|gif\|png) Recommended size : 1051x1205px (89x102mm)` You can use Image object to create a image ressource
image_url_12	An url of an image (full size) for the polaroid `(jpg\|gif\|png) Recommended size : 1051x1205px (89x102mm)` You can use Image object to create a image ressource
pic_url_1	An url of an square image for the polaroid (image top) `(jpg\|gif\|png) Recommended size : 933x933px (79x79mm)` You can use Image object to create a image ressource
pic_url_2	An url of an square image for the polaroid (image top) `(jpg\|gif\|png) Recommended size : 933x933px (79x79mm)` You can use Image object to create a image ressource
pic_url_3	An url of an square image for the polaroid (image top) `(jpg\|gif\|png) Recommended size : 933x933px (79x79mm)` You can use Image object to create a image ressource
pic_url_4	An url of an square image for the polaroid (image top) `(jpg\|gif\|png) Recommended size : 933x933px (79x79mm)` You can use Image object to create a image ressource
pic_url_5	An url of an square image for the polaroid (image top) `(jpg\|gif\|png) Recommended size : 933x933px (79x79mm)` You can use Image object to create a image ressource
pic_url_6	An url of an square image for the polaroid (image top) `(jpg\|gif\|png) Recommended size : 933x933px (79x79mm)` You can use Image object to create a image ressource
pic_url_7	An url of an square image for the polaroid (image top) `(jpg\|gif\|png) Recommended size : 933x933px (79x79mm)` You can use Image object to create a image ressource
pic_url_8	An url of an square image for the polaroid (image top) `(jpg\|gif\|png) Recommended size : 933x933px (79x79mm)` You can use Image object to create a image ressource
pic_url_9	An url of an square image for the polaroid (image top) `(jpg\|gif\|png) Recommended size : 933x933px (79x79mm)` You can use Image object to create a image ressource
pic_url_10	An url of an square image for the polaroid (image top) `(jpg\|gif\|png) Recommended size : 933x933px (79x79mm)` You can use Image object to create a image ressource
pic_url_11	An url of an square image for the polaroid (image top) `(jpg\|gif\|png) Recommended size : 933x933px (79x79mm)` You can use Image object to create a image ressource
pic_url_12	An url of an square image for the polaroid (image top) `(jpg\|gif\|png) Recommended size : 933x933px (79x79mm)` You can use Image object to create a image ressource
text_1	Small text at the bottom of the Polaroid `(30 characters max.)`
text_2	Small text at the bottom of the Polaroid `(30 characters max.)`
text_3	Small text at the bottom of the Polaroid `(30 characters max.)`
text_4	Small text at the bottom of the Polaroid `(30 characters max.)`
text_5	Small text at the bottom of the Polaroid `(30 characters max.)`
text_6	Small text at the bottom of the Polaroid `(30 characters max.)`
text_7	Small text at the bottom of the Polaroid `(30 characters max.)`
text_8	Small text at the bottom of the Polaroid `(30 characters max.)`
text_9	Small text at the bottom of the Polaroid `(30 characters max.)`
text_10	Small text at the bottom of the Polaroid `(30 characters max.)`
text_11	Small text at the bottom of the Polaroid `(30 characters max.)`
text_12	Small text at the bottom of the Polaroid `(30 characters max.)`
message	A message printed for the recipient
logo_url	An url of an image to show a logo `(jpg\|gif\|png)` `(max_width=800px,max_height=400px)` You can use Image object to create a image ressource
custom	A custom field for your use
date_creation	The creation date for the card

api/polaroidbox (POST)

Description	Creates a new polaroidbox
Url	`http://api.printofoto.com/api/polaroidbox`
Method	POST
Parameters	`image_url_1` (mandatory if no pic_url_1 \| Url of image resource) `image_url_2` (mandatory if no pic_url_2 \| Url of image resource) `image_url_3` (mandatory if no pic_url_3 \| Url of image resource) `image_url_4` (mandatory if no pic_url_4 \| Url of image resource) `image_url_5` (mandatory if no pic_url_5 \| Url of image resource) `image_url_6` (mandatory if no pic_url_6 \| Url of image resource) `image_url_7` (mandatory if no pic_url_7 \| Url of image resource) `image_url_8` (mandatory if no pic_url_8 \| Url of image resource) `image_url_9` (mandatory if no pic_url_9 \| Url of image resource) `image_url_10` (mandatory if no pic_url_10 \| Url of image resource) `image_url_11` (mandatory if no pic_url_11 \| Url of image resource) `image_url_12` (mandatory if no pic_url_12 \| Url of image resource) `pic_url_1` (mandatory if no image_url_1 \| Url of image resource) `pic_url_2` (mandatory if no image_url_2 \| Url of image resource) `pic_url_3` (mandatory if no image_url_3 \| Url of image resource) `pic_url_4` (mandatory if no image_url_4 \| Url of image resource) `pic_url_5` (mandatory if no image_url_5 \| Url of image resource) `pic_url_6` (mandatory if no image_url_6 \| Url of image resource) `pic_url_7` (mandatory if no image_url_7 \| Url of image resource) `pic_url_8` (mandatory if no image_url_8 \| Url of image resource) `pic_url_9` (mandatory if no image_url_9 \| Url of image resource) `pic_url_10` (mandatory if no image_url_10 \| Url of image resource) `pic_url_11` (mandatory if no image_url_11 \| Url of image resource) `pic_url_12` (mandatory if no image_url_12 \| Url of image resource) `text_1` (optional \| String) `text_2` (optional \| String) `text_3` (optional \| String) `text_4` (optional \| String) `text_5` (optional \| String) `text_6` (optional \| String) `text_7` (optional \| String) `text_8` (optional \| String) `text_9` (optional \| String) `text_10` (optional \| String) `text_11` (optional \| String) `text_12` (optional \| String) `logo_url` (optional \| String) `message` (optional \| String) `custom` (optional \| String)
Returns	JSON object representing the new polaroidbox (see /PolaroidBox (GET) for details )
Return code	`201` - Object polaroidbox was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/polaroidbox/{id} (GET)

Description	Gets information of an existing polaroidbox
Url	`http://api.printofoto.com/api/polaroidbox/{id}`
Method	GET
Parameters	`id` Unique Identifier of a polaroidbox
Returns	JSON object representing the polaroidbox (see /PolaroidBox (GET) for details )
Return code	`404` - PolaroidBox with the specified id was not found

api/polaroidbox/{id} (PUT)

Description	Update a polaroidbox
Url	`http://api.printofoto.com/api/polaroidbox/{id}`
Method	PUT
Parameters	`image_url_1` (mandatory if no pic_url_1 \| Url of image resource) `image_url_2` (mandatory if no pic_url_2 \| Url of image resource) `image_url_3` (mandatory if no pic_url_3 \| Url of image resource) `image_url_4` (mandatory if no pic_url_4 \| Url of image resource) `image_url_5` (mandatory if no pic_url_5 \| Url of image resource) `image_url_6` (mandatory if no pic_url_6 \| Url of image resource) `image_url_7` (mandatory if no pic_url_7 \| Url of image resource) `image_url_8` (mandatory if no pic_url_8 \| Url of image resource) `image_url_9` (mandatory if no pic_url_9 \| Url of image resource) `image_url_10` (mandatory if no pic_url_10 \| Url of image resource) `image_url_11` (mandatory if no pic_url_11 \| Url of image resource) `image_url_12` (mandatory if no pic_url_12 \| Url of image resource) `pic_url_1` (mandatory if no image_url_1 \| Url of image resource) `pic_url_2` (mandatory if no image_url_2 \| Url of image resource) `pic_url_3` (mandatory if no image_url_3 \| Url of image resource) `pic_url_4` (mandatory if no image_url_4 \| Url of image resource) `pic_url_5` (mandatory if no image_url_5 \| Url of image resource) `pic_url_6` (mandatory if no image_url_6 \| Url of image resource) `pic_url_7` (mandatory if no image_url_7 \| Url of image resource) `pic_url_8` (mandatory if no image_url_8 \| Url of image resource) `pic_url_9` (mandatory if no image_url_9 \| Url of image resource) `pic_url_10` (mandatory if no image_url_10 \| Url of image resource) `pic_url_11` (mandatory if no image_url_11 \| Url of image resource) `pic_url_12` (mandatory if no image_url_12 \| Url of image resource) `text_1` (optional \| String) `text_2` (optional \| String) `text_3` (optional \| String) `text_4` (optional \| String) `text_5` (optional \| String) `text_6` (optional \| String) `text_7` (optional \| String) `text_8` (optional \| String) `text_9` (optional \| String) `text_10` (optional \| String) `text_11` (optional \| String) `text_12` (optional \| String) `logo_url` (optional \| String) `message` (optional \| String) `custom` (optional \| String)
Returns	JSON object representing the polaroidbox (see /PolaroidBox (GET) for details)
Return code	`200` - Object polaroidbox was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No polaroidbox was found

api/polaroidbox/{id} (DELETE)

Description	Delete a polaroidbox
Url	`http://api.printofoto.com/api/polaroidbox/{id}`
Method	DELETE
Parameters	`id` (mandatory in URL \| Integer)
Return code	`204` - No content - Object polaroidbox was deleted `404` - No polaroidbox was found

Postcard

api/postcard (GET)

Description

Retrieves information about the different postcards

Url

http://api.printofoto.com/api/postcard

Method

GET

Parameters

date_from Only retrieve postcard with creation_date less than the specified value.
date_to Only retrieve postcard with creation_date after than the specified value.
custom Only retrieve postcard with custom field equal the specified value.

Returns

JSON object containing information on any errors or warnings associated with the postcard

Sample JSON response

[{
	"id_postcard":"1",
	"image_url":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"logo_url":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"stamp_url":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"text":"Hi, a small souvenir photo of our holiday spent together. Kisses",
	"shipping_firstname":"Jean",
	"shipping_name":"Dupond",
	"shipping_company":"",
	"shipping_address_1":"12 rue du stade",
	"shipping_address_2":"Bat A1",
	"shipping_zipcode":"75001",
	"shipping_city":"Paris",
	"shipping_country":"France",
	"custom":"holliday",
	"date_creation":"2015-01-05 15:31:04"
},
{
	"id_postcard":"2",
	"image_url":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"logo_url":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"stamp_url":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"text":"Sun, snow, skiing",
	"shipping_firstname":"Jean",
	"shipping_name":"Dupond",
	"shipping_company":"",
	"shipping_address_1":"12 rue du stade",
	"shipping_address_2":"Bat A1",
	"shipping_zipcode":"75001",
	"shipping_city":"Paris",
	"shipping_country":"France",
	"custom":"holliday",
	"date_creation":"2015-01-05 15:31:04"
,
...
}]

Postcard Item

Field	Description
id_postcard	Unique Identifier of a postcard
image_url	An url of an image for the cover of the postcard `(jpg\|gif\|png - 15x11cm 300dpi - 1772x1299px)` You can use Image object to create a image ressource
logo_url	An url of an logo for the back of the postcard `(jpg\|gif\|png)` You can use Image object to create a image ressource
stamp_url	An url of an image for stamp of the postcard `(jpg\|gif\|png - 1.6x2cm 300dpi - 189x236px)` You can use Image object to create a image ressource
text	The text of the postcard
shipping_firstname	The firstname who the postcard should be addressed
shipping_name	The name who the postcard should be addressed
shipping_company	The name of the company who the postcard should be addressed
shipping_address_1	1st line of address who the postcard should be addressed
shipping_address_2	2nd line of address who the postcard should be addressed
shipping_zipcode	The zipcode who the postcard should be addressed
shipping_city	The city who the postcard should be addressed
shipping_country	The country who the postcard should be addressed
custom	A custom field for your use
date_creation	The creation date for the photobook

api/postcard (POST)

Description	Creates a new postcard
Url	`http://api.printofoto.com/api/postcard`
Method	POST
Parameters	`image_url` (mandatory \| Url of image resource) `logo_url` (optional \| Url of image resource) `stamp_url` (optional \| Url of image resource) `text` (mandatory \| String) `shipping_firstname` (mandatory \| String) `shipping_name` (mandatory \| String) `shipping_company` (optional \| String) `shipping_address_1` (mandatory \| String) `shipping_address_2` (optional \| String) `shipping_zipcode` (mandatory \| String) `shipping_city` (mandatory \| String) `shipping_country` (mandatory \| String) `custom` (optional \| String)
Returns	JSON object representing the new postcard (see /Postcard (GET) for details )
Return code	`201` - Object postcard was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/postcard/{id} (GET)

Description	Gets information of an existing postcard
Url	`http://api.printofoto.com/api/postcard/{id}`
Method	GET
Parameters	`id` Unique Identifier of a postcard
Returns	JSON object representing the postcard (see /Postcard (GET) for details )
Return code	`404` - Postcard with the specified id was not found

api/postcard/{id} (PUT)

Description	Update a postcard
Url	`http://api.printofoto.com/api/postcard/{id}`
Method	PUT
Parameters	`id` (mandatory in URL \| Integer) `image_url` (mandatory \| Url of image resource) `logo_url` (mandatory \| Url of image resource) `stamp_url` (mandatory \| Url of image resource) `text` (mandatory \| String) `shipping_firstname` (mandatory \| String) `shipping_name` (mandatory \| String) `shipping_company` (optional \| String) `shipping_address_1` (mandatory \| String) `shipping_address_2` (optional \| String) `shipping_zipcode` (mandatory \| String) `shipping_city` (mandatory \| String) `shipping_country` (mandatory \| String) `custom` (optional \| String)
Returns	JSON object representing the postcard (see /Postcard (GET) for details )
Return code	`200` - Object postcard was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No postcard was found

api/postcard/{id} (DELETE)

Description	Delete a postcard
Url	`http://api.printofoto.com/api/postcard/{id}`
Method	DELETE
Parameters	`id` (mandatory in URL \| Integer)
Return code	`204` - No content - Object postcard was deleted `404` - No postcard was found

Poster

api/poster (GET)

Description

Retrieves information about the different posters

Url

http://api.printofoto.com/api/poster

Method

GET

Parameters

date_from Only retrieve poster with creation_date less than the specified value.
date_to Only retrieve poster with creation_date after than the specified value.
custom Only retrieve poster with custom field equal the specified value.

Returns

JSON object containing information on any errors or warnings associated with the poster

Sample JSON response

[{
	"id_poster":"1",
	"image_url":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"custom":"christmas",
	"date_creation":"2015-01-05 15:31:04",
},
{
	"id_poster":"2",
	"image_url":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"custom":"dogs",
	"date_creation":"2015-01-05 15:31:04",
,
...
}]

Poster Item

Field	Description
id_poster	Unique Identifier of a poster
image_url	An url of an image for the poster `(jpg\|gif\|png - 29.7x42cm 300dpi - 3508x4961px)` You can use Image object to create a image ressource
logo_url	An url of an image to show a logo at the back of the poster `(jpg\|gif\|png)` `(max_width=800px,max_height=400px)` You can use Image object to create a image ressource
format	Format for the poster (default: 297x420)
custom	A custom field for your use
date_creation	The creation date for the poster

api/poster (POST)

Description	Creates a new poster
Url	`http://api.printofoto.com/api/poster`
Method	POST
Parameters	`image_url` (mandatory \| Url of image resource) `logo_url` (optional \| Url of image resource) `custom` (optional \| String) `format` (optional \| String \| 297x420 or 420x297)
Returns	JSON object representing the new poster (see /Poster (GET) for details )
Return code	`201` - Object poster was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/poster/{id} (GET)

Description	Gets information of an existing poster
Url	`http://api.printofoto.com/api/poster/{id}`
Method	GET
Parameters	`id` Unique Identifier of a poster
Returns	JSON object representing the poster (see /Poster (GET) for details )
Return code	`404` - Poster with the specified id was not found

api/poster/{id} (PUT)

Description	Update a poster
Url	`http://api.printofoto.com/api/poster/{id}`
Method	PUT
Parameters	`id` (mandatory in URL \| Integer) `image_url` (mandatory \| Url of image resource) `logo_url` (optional \| Url of image resource) `custom` (optional \| String) `format` (optional \| String \| 297x420 or 420x297)
Returns	JSON object representing the poster (see /Poster (GET) for details )
Return code	`200` - Object poster was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No poster was found

api/poster/{id} (DELETE)

Description	Delete a poster
Url	`http://api.printofoto.com/api/poster/{id}`
Method	DELETE
Parameters	`id` (mandatory in URL \| Integer)
Return code	`204` - No content - Object poster was deleted `404` - No poster was found

StickerGrid

api/stickergrid (GET)

Description

Retrieves information about the different stickergrids

Url

http://api.printofoto.com/api/stickergrid

Method

GET

Parameters

date_from Only retrieve stickergrid with creation_date less than the specified value.
date_to Only retrieve stickergrid with creation_date after than the specified value.
custom Only retrieve stickergrid with custom field equal the specified value.

Returns

JSON object containing information on any errors or warnings associated with the sticker

Sample JSON response

[{
	"id_stickergrid":"1",
	"image_url_1":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_2":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_3":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_4":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_5":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_6":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_7":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_8":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_9":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"custom":"christmas",
	"date_creation":"2015-01-05 15:31:04",
},
{
	"id_stickergrid":"2",
	"image_url_1":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_2":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_3":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_4":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_5":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_6":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_7":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_8":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"image_url_9":"http://api.printofoto.com/images/113/373/145/b36d0.jpg",
	"custom":"dogs",
	"date_creation":"2015-01-05 15:31:04",
,
...
}]

stickerGrid Item

Field	Description
id_stickergrid	Unique Identifier of a stickergrid
image_url_1	An url of an image for the sticker `(jpg\|gif\|png - 5x5cm 300dpi - 591x591px)` You can use Image object to create a image ressource
image_url_2	An url of an image for the sticker `(jpg\|gif\|png - 5x5cm 300dpi - 591x591px)` You can use Image object to create a image ressource
image_url_3	An url of an image for the sticker `(jpg\|gif\|png - 5x5cm 300dpi - 591x591px)` You can use Image object to create a image ressource
image_url_4	An url of an image for the sticker `(jpg\|gif\|png - 5x5cm 300dpi - 591x591px)` You can use Image object to create a image ressource
image_url_5	An url of an image for the sticker `(jpg\|gif\|png - 5x5cm 300dpi - 591x591px)` You can use Image object to create a image ressource
image_url_6	An url of an image for the sticker `(jpg\|gif\|png - 5x5cm 300dpi - 591x591px)` You can use Image object to create a image ressource
image_url_7	An url of an image for the sticker `(jpg\|gif\|png - 5x5cm 300dpi - 591x591px)` You can use Image object to create a image ressource
image_url_8	An url of an image for the sticker `(jpg\|gif\|png - 5x5cm 300dpi - 591x591px)` You can use Image object to create a image ressource
image_url_9	An url of an image for the sticker `(jpg\|gif\|png - 5x5cm 300dpi - 591x591px)` You can use Image object to create a image ressource
custom	A custom field for your use
date_creation	The creation date for the card

api/stickergrid (POST)

Description	Creates a new stickergrid
Url	`http://api.printofoto.com/api/stickergrid`
Method	POST
Parameters	`image_url_1` (mandatory \| Url of image resource) `image_url_2` (mandatory \| Url of image resource) `image_url_3` (mandatory \| Url of image resource) `image_url_4` (mandatory \| Url of image resource) `image_url_5` (mandatory \| Url of image resource) `image_url_6` (mandatory \| Url of image resource) `image_url_7` (mandatory \| Url of image resource) `image_url_8` (mandatory \| Url of image resource) `image_url_9` (mandatory \| Url of image resource) `custom` (optional \| String)
Returns	JSON object representing the new stickergrid (see /stickerGrid (GET) for details )
Return code	`201` - Object stickergrid was created `400` - One of the input parameters was invalid or missing, error message should indicate which one and why

api/stickergrid/{id} (GET)

Description	Gets information of an existing stickergrid
Url	`http://api.printofoto.com/api/stickergrid/{id}`
Method	GET
Parameters	`id` Unique Identifier of a stickergrid
Returns	JSON object representing the stickergrid (see /stickerGrid (GET) for details )
Return code	`404` - stickerGrid with the specified id was not found

api/stickergrid/{id} (PUT)

Description	Update a stickergrid
Url	`http://api.printofoto.com/api/stickergrid/{id}`
Method	PUT
Parameters	`image_url_1` (mandatory \| Url of image resource) `image_url_2` (mandatory \| Url of image resource) `image_url_3` (mandatory \| Url of image resource) `image_url_4` (mandatory \| Url of image resource) `image_url_5` (mandatory \| Url of image resource) `image_url_6` (mandatory \| Url of image resource) `image_url_7` (mandatory \| Url of image resource) `image_url_8` (mandatory \| Url of image resource) `image_url_9` (mandatory \| Url of image resource) `custom` (optional \| String)
Returns	JSON object representing the stickergrid (see /stickerGrid (GET) for details )
Return code	`200` - Object stickergrid was updated `400` - One of the input parameters was invalid or missing, error message should indicate which one and why `404` - No stickergrid was found

api/stickergrid/{id} (DELETE)

Description	Delete a stickergrid
Url	`http://api.printofoto.com/api/stickergrid/{id}`
Method	DELETE
Parameters	`id` (mandatory in URL \| Integer)
Return code	`204` - No content - Object stickergrid was deleted `404` - No stickergrid was found

Notre API d'impression de produits photos personnalisables

Documentation technique de l'API

URLs

Sandbox API URL:

Live API URL:

General notes

Request Format

Response Format

Standard API return codes

Authentication

Filtering Resources

Limit

Offset

Sort

PHP Class

Bookmark

Description

Url

Method

Parameters

Returns

Bookmark Item

Description

Url

Method

Parameters

Returns

Return code

Description

Url

Method

Parameters

Returns

Return code

Description

Url

Method

Parameters

Returns

Return code

Description

Url

Method

Parameters

Return code

BusinessCard

Description

Url

Method

Parameters

Returns

Businesscard Item

Description

Url

Method

Parameters

Returns

Return code

Description

Url

Method

Parameters

Returns

Return code

Description

Url

Method

Parameters

Returns

Return code

Description

Url

Method

Parameters

Return code

Calendar

Description

Url

Method

Parameters