001_Snipon_API_11.PDF

Dokumentation API Snipon Version 2.0 

The Snipon Api is the programming interface to the Snipon web portal. You can use the API to get 

data from the Snipon web service to integrate it in your app or website. 

API Calls 

The Snipon API follows a RESTful API design. You use standard HTTP methods to retrieve resources. 

You can pass the type parameter to every API Call. Currently this parameter supports only the value 

xml. You can also use the HTTP request-header field Accept for this function and set it to 

Accept: text/xml 

Paging 

All resources support paging. To use this you need to pass the two parameters limit and offset to the 

API Call. The value of limit describes the maximum of objects delivered through the API Call. The 

value of offset describes how much objects already been delivered. Usually offset should be 0 for the 

first call. If you use paging all resources contains a link to the next elements of the resource if there 

any. The property name which contains the URL is . For the previous elements the URL is 

the value of the property named . 

Example: 

GET http://snipon.de/api/Tradingcompany/?type=xml&apikey=&limit=100&offset=0


You can retrieve the following resources through API Calls: 

Tradingcompany: 

Tradingcompany is a list of Tradingcompanies. The Tradingcompany methods enable your application to get 

all Tradingcompanies as a list or a Tradingcompany. Each Tradingcompany has an uniquely identifying ID. 

GET http://snipon.de/api/Tradingcompany/?type=xml&apikey= 

Example: 

 

 

akzenta 

http://snipon.de/logo/Akzenta-logo.png 

Supermärkte 

http://snipon.de/api/Store/tradingcompanyid/2/ 

 

 

Aldi-Nord 

http://snipon.de/logo/Aldi-Nord-logo.png 

Discounter 

http://snipon.de/api/Store/tradingcompanyid/2/ 

 


Property Name Value Description 

id string The ID of this Company 

companyname string Name of the Company 

companylogo string URL of the logo 

companyclassification string The Companyclassification currently 

with the following 

classifications: 

Autowerkstätten 

Baumärkte 

Biomärkte 

Coupons 

Discounter 

Drogerien 

Einrichtungsmärkte 

Getränkemärkte 

Kaufhäuser 

Motorradausstatter 

Non-Food-Discounter 

Schuhmärkte 

Sportgeschäfte 

Supermärkte 

Technikmärkte 

Textilmärkte 

Tiernahrung 

Verlag 

Versicherung 

stores_url string API Call URL for the stores of 

this company 

GET http://snipon.de/api/Tradingcompany/1/?type=xml&apikey= 

This gives your Application the representation of the tradingcompany with the id = 1.


Stores: 

Store is a list of Stores. The Store methods enable your application to get all Stores as a list, a 

specific store or all Stores of a specific company. Each Store has a uniquely identifying ID. 

Example: 

GET http://snipon.de/api/Store/?type=xml&apikey= 

 

 

1 

Überregional 

51.2565483 

7.1483858 

Hans Löbbert GmbH & Co. KG 

Alte Freiheit 

9 

42103 

Wuppertal 

 

0202-45966-0 

0202-45966-22 

1 

 

 

1 

Überregional 

51.2509921 

7.1371319 

Hans Löbbert GmbH & Co. KG 

Tannenbergstr. 

58 

42103 

Wuppertal 

 

0202-37132-0 

0202-37132-22 

1 

 

… 



id string The ID of this Store 

districtnameid string The ID of the Districtname of the 

Store- this is important for the Relation 

between Store and a Flyer 

districtnamename string The Name of the Districtname 

storelat string lat-Coordinate for the store 

storelng string lng-Coordinate for the store 

storename string The name of the store 

storeadress string The Address (Street) of the store 

storenum string The street number of the store 

storezip string The Zip code of the store 

storecity string The City of the store 

storebusinesshours string The business hours of the store 

storetel string The phone number of the store 

storefax string The fax number of the store 

tradingcompanyid string The id of the tradingcompany running 

this store 

GET http://snipon.de/api/Store/34038/?type=xml&apikey= 

With this call you get the store with the id = 34038 

GET http://snipon.de/api/Store/Tradingcompanyid/1/?type=xml&apikey= 

With this call you get all stores of the tradingcompany with the id=1.


Flyer: 

Flyer is a list of current Flyer. The Flyer methods enable your application to get all current Flyers 

as a list, a specific Flyer or all Flyers of a specific company. Each Flyer has a uniquely identifying 

ID. 

GET http://snipon.de/api/Flyer/?type=xml&apikey= 


id string The ID of this Flyer 

companyname string The Companyname which published the Flyer 

tradingcompanyid string The ID of the Company which published the Flyer 

flyerdatefrom string Start date of the Flyer. On this date the offers 

should be available in the stores. 

flyerdateto string End date of the Flyer. Till this date the offers 

should be available in the stores. 

flyersizex string Width of the flyer in pixel taken from the first page. 

flyersizey string Height of the flyer in pixel taken from the first 

page. 

flyerpagecount string Count of the pages of the flyer. 

districtnameid string The ID of the districtname. For the relation between 

a Store and a Flyer. 

flyername string The Name of the Flyer 

flyerpages object List of Flyerpages 

GET http://snipon.de/api/Flyer/ 30249/?type=xml&apikey= 

With this call you get the Flyer with the id = 30249 

GET http://snipon.de/api/Flyer/Tradingcompanyid/1/?type=xml&apikey= 

With this call you get all flyers from the tradingcompany with the id = 1


FlyerPage 

The resource FlyerPage usually gets used with the API call of the Flyer resource. It is a list with flyer 

pages for a specific flyer or a specific flyer page. 


id string The ID of this FlyerPage 

flyerpagetext string The Text of the FlyerPage. Most of the time, this text is delivered 

through the text in PDF-files. Sometimes the text 

comes from an OCR-Software. 

flyerpagenr string Page number of the Page 

flyerpagedatefrom string Start date of the FlyerPage. On this date the offers on this 

Page should be available in the stores. 

flyerpagedateto string End date of the FlyerPage. Till this date the offers should be 

available in the stores. 

flyersizefullx string Width of the FlyerPage for the full view in pixel. 

flyersizefully string Height of the FlyerPage for the full view in pixel. 

flyersizenormalx string Width of the FlyerPage for the normal view in pixel. 

flyersizenormaly string Height of the FlyerPage for the normal view in pixel. 

flyersizethumbx string Width of the FlyerPage for the thumb view in pixel. 

flyersizethumby string Height of the FlyerPage for the thumb view in pixel. 

image_full string URL to the image of the FlyerPage for the full view. 

image_normal string URL to the image of the FlyerPage for the normal view. 

image_thumb string URL to the image of the FlyerPage for the thumb view. 

Used during the API call of Flyer.


FlyerItem: 

FlyerItem is a list of all current offers in the current flyers. The FlyerItem methods enable your application 

to get all current FlyerItems as a list, a specific FlyerItem or all FlyerItems of a specific Flyer. Each FlyerItem 

has a uniquely identifying ID. 

GET http://snipon.de/api/FlyerItem/?type=xml&apikey= 


id string The ID of this FlyerItem 

flyerpageid 

The ID of the FlyerPage 

flyeritemprice 

Price of the FlyerItem 

flyeritemdesc 

The description text of the FlyerItem 

flyeritemx 

XPosition of the FlyerItem-Picture on the FlyerPage 

flyeritemy 

YPosition of the FlyerItem-Picture on the FlyerPage 

flyeritemh 

Height of the FlyerItem-Picture on the FlyerPage 

flyeritemw 

Width of the FlyerItem-Picture on the FlyerPage 

productname 

string The Productname 

productbrand 

The Brand of the Product 

productmanufacturer The Manufacturer of the Product 

flyerpagenr 

The Pagenumber 

flyerid 

The flyerid 

districtnameid 

The ID of the Districtname of the Store- this is important for the Relation 

between Store and a FlyerItem / Flyer 

tradingcompanyid 

The ID of the Tradingcompany 

subcategoryid 

subcategoryname 

categoryid 

categoryname 

sectionid 

sectionname 

flyeritemcount 

flyeritemsize 

flyeritemunit 

The packaging size of the FlyerItem. To use with the property flyeritemunit. 

For example: 

flyeritemsize = 1 

flyeritemunit = kg 

The packaging unit of the FlyerItem. For example: 

St – Stück 

kg - Kilogramm 

flyeritemimage 

URL of the Image of the FlyerItem


GET http://snipon.de/api/FlyerItem/234567/?type=xml&apikey= 

With this call you get the FlyerItem with the id = 234567 

GET http://snipon.de/api/FlyerItem/flyereid/123456/?type=xml&apikey= 

With this call you get all flyeritems from the flyer with the id = 123456 

GET http://snipon.de/api/FlyerItem/flyerpageid/1212/?type=xml&apikey= 

With this call you get all flyeritems from the flyerpage with the id = 1212

001_Snipon_API_11.PDF

Create successful ePaper yourself

Delete template?

Save as template?