Api Developer Documentation

Introduction

iDealFeeds is a central deal database having SEO rich content from leading merchants and affiliate networks in Asia.

Deal data feeds can be accessed via a powerful API containing merchants, coupon codes and from the top affiliate networks, including start / expiry dates, titles, descriptions, categories, merchant id's, program id's, merchant logos, merchant urls and built deep links / affiliate urls in the XML/CSV/JSON formats.

iDealFeeds issue an APIKey after registration. A separate APIKey is required to access data from specific countries.

Note: the iDealFeeds API Key is a unique token required to be eligible to access the API feeds. It is our way of authenticating that the iDealFeeds client has access to the API.

  1. Only one APIKey per country is allowed
  2. Every API request will contain a valid, active APIKey and data format parameter

Response format

The deals (coupons and discounts) will be accessible from the iDealFeeds database via a secured API in XML/CSV/JSON format. The following data formats are available:

  1. JSON: JavaScript Object Notation (Recommended)
  2. XML: Extensible Markup Language
  3. CSV: Comma Separated Values

API Request

Data feeds are accessible to clients via a web API with client id and API signature to make the API secured. We will issue the client id and API signature after client registration. The iDealFeeds API allows only the GET method.

http://api.idealfeeds.com/{APIKEY}/{MethodName}/{DataFormat}

Where

APIKey

The APIKey used for API request authentication and this mandatory parameter of the API request call. The APIKey is Issued by iDealFeeds after successful registration. The APIKey is country specific, so if the client subscribes to plans from multiple countries, then iDealFeeds will generate unique APIKey for each country.

MethodName

This is also a mandatory parameter of the API request call. This parameter can be used to get specific data from the API, e.g. deals, merchants, networks and categories etc.

DataFormat

This is also a mandatory parameter of the API request call. This parameter can be used to get data in a specific format, i.e. JSON, XML & CSV.

Access Deals

API Request URL Format: http://api.idealfeeds.com/{APIKEY}/{MethodName}/{DataFormat}?SortBy={SortByValue}&MerchantName={ MerchantName}&Category={CategoryName}&OfferType={OfferType}&PageNo={PageNo}&PageSize={PageSize}

ParameterValueTypeNote
API KEY----MandatoryShould have valid and active APIKey
MethodNameGetDealsMandatory
DataFormatJSON | XML | CSVMandatoryOnly one data type is allowed at a time. Please use JSON or XML or CSV
SortBySTARTDATE | ENDDATE | MERCHANTNAME | OFFERTYPEOptionalUse this parameter if you want to get results sorted by specific fields. Only one field is allowed for sorting in API request.
MerchantNameOptionalPass merchant name if you want to get deals from specific merchant.
CategoryOptionalPass category name if you want to get deals from specific categories.
OfferTypeAll | Coupon | DiscountOptionalPass OFFERTYPE if you want to filter deals by specific type, e.g. coupon, discount etc.
PageNoOptionalBy default API returns all data. But data required in paging, then pass page no. With this parameter PageSize parameter is required.
PageSizeOptionalPass the value if the data required in paging. This parameter used to set the number of records in a page.

Example:

  1. Get coupon type deals from fashion category from Zalora merchant and in StartDate sorting order of page size 25. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetDeals/Json?SortBy=STARTDATE &MerchantName=ZALORA&Category=Faishon&OfferType=Coupons&PageNo=1&PageSize=25
  2. Get all deals from fashion category from Zalora merchant and in StartDate sorting order of page size 25. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetDeals/Json?SortBy=STARTDATE &MerchantName=ZALORA&Category=Faishon&PageNo=1&PageSize=25
  3. Get all deals from Zalora merchant and in StartDate sorting order of page size 25. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetDeals/Json?SortBy=STARTDATE &MerchantName=ZALORA&PageNo=1&PageSize=25
  4. Get all deals from all subscribed merchants in StartDate sorting order of page size 25. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetDeals/Json?SortBy=STARTDATE &MerchantName=ZALORA&PageNo=1&PageSize=25
  5. Get all deals from all subscribed merchants without paging and sorting API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetDeals/Json

User same as above for XML and CSV format, only need to replace data format parameter values i.e. replaces json by xml or csv

Access Networks

API Request URL Format: http://api.idealfeeds.com/{APIKEY}/{MethodName}/{DataFormat}?NetworkName ={ NetworkName }&RelationType={RelationType}&PageNo={PageNo}&PageSize={PageSize}

ParameterValueTypeNote
API KEY----MandatoryShould have valid and active APIKey
MethodNameGetNetworksMandatory
DataFormatJSON | XML | CSVMandatoryOnly one data type is allowed at a time. Please use JSON or XML or CSV
NetworkNameOptionalUse this filter parameter if you want to filer networks by network name. Pass few characters from beginning of network name.
RelationTypeJOINED | ALLOptionalPass this, if you want to access the networks which you added to your iDealFeeds account.
PageNoOptionalBy default API returns all data. But data required in paging, then pass page no. With this parameter PageSize parameter is required.
PageSizeOptionalPass the value if the data required in paging. This parameter used to set the number of records in a page.

Example:

  1. Get all networks without paging. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetNetworks/Json
  2. Get all networks of page size 25. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetNetworks/Json?PageNo=1&PageSize=25
  3. Get all networks joined/added to the iDealFeeds account of page size 25. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetNetworks/Json? RelationType=JOINED&PageNo=1&PageSize=25
  4. Search networks by network name start with Optimise in the iDealFeeds account, of page size 25. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetNetworks/Json?NetworkName=Optimise &PageNo=1&PageSize=25

Access Merchants

API Request URL Format: http://api.idealfeeds.com/{APIKEY}/{MethodName}/{DataFormat}?MerchantName={ MerchantName}&RelationType={RelationType}&PageNo={PageNo}&PageSize={PageSize}

ParameterValueTypeNote
API KEY----MandatoryShould have valid and active APIKey
MethodNameGetMerchantsMandatory
DataFormatJSON | XML | CSVMandatoryOnly one data type is allowed at a time. Please use JSON or XML or CSV
MerchantNameOptionalUse this filter parameter if you want to filter merchants by merchant name. Pass few characters from beginning of merchant name.
RelationTypeJOINED | ALLOptionalPass this, if you want to access the merchants which you added to your iDealFeeds account.
PageNoOptionalBy default API returns all data. But data required in paging, then pass page no. With this parameter PageSize parameter is required.
PageSizeOptionalPass the value if the data required in paging. This parameter used to set the number of records in a page.

Example:

  1. Get all merchants without paging. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetMerchants/Json
  2. Get all merchants of page size 25. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetMerchants /Json?PageNo=1&PageSize=25
  3. Get all merchants joined/added to the iDealFeeds account, of page size 25. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetMerchants/Json? RelationType=JOINED&PageNo=1&PageSize=25
  4. Search merchants by merchant name. Start with Zal (for Zalora search) to the iDealFeeds account, of page size 25. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetMerchants /Json?MerchantName=Zal &PageNo=1&PageSize=25

User same as above for XML and CSV format, only need to replace data format parameter values i.e.replaces json by xml or csv.

Access Categories

API Request URL Format: http://api.idealfeeds.com/{APIKEY}/{MethodName}/{DataFormat}?CategoryName={ CategoryName}&RelationType={RelationType}&PageNo={PageNo}&PageSize={PageSize}

ParameterValueTypeNote
API KEY----MandatoryShould have valid and active APIKey
MethodNameGetCategoriesMandatory
DataFormatJSON | XML | CSVMandatoryOnly one data type is allowed at a time. Please use JSON or XML or CSV
CategoryNameOptionalUse this filter parameter if you want to filter categories by category name. Pass few characters from beginning of the category name.
RelationTypeJOINED | ALLOptionalPass this, if you want to access the categories which you added to your iDealFeeds account.
PageNoOptionalBy default API returns all data. But data required in paging, then pass page no. With this parameter PageSize parameter is required.
PageSizeOptionalPass the value if the data required in paging. This parameter used to set number of records in a page.

Example:

  1. Get all categories without paging. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetCategories/Json
  2. Get all categories of page size 25. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetCategories /Json?PageNo=1&PageSize=25
  3. Get all categories joined/added to the iDealFeeds account, of page size 25. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetCategories/Json? RelationType=JOINED&PageNo=1&PageSize=25
  4. Search categories by category name start with Fash (for Fashion search) in the iDealFeeds account, of page size 25. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetCategories/Json?CategoryName=fash &PageNo=1&PageSize=25

User same as above for XML and CSV format, only need to replace data format parameter values i.e.replaces json by xml or csv.

Access Sales

This method is accessible to revenue share plan. You have subscribed revenue share plan then you can access the sale data via API.

API Request URL Format: http://api.idealfeeds.com/{APIKEY}/{MethodName}/{DataFormat}?NetworkName={ NetworkName}&MerchantNam={MerchantName}&Status={Status}&PageNo={PageNo}&PageSize={PageSize}

ParameterValueTypeNote
API KEY----MandatoryShould have valid and active APIKey
MethodNameGetSalesMandatory
DataFormatJSON | XML | CSVMandatoryOnly one data type is allowed at a time. Please use JSON or XML or CSV
NetworkNameOptionalIf you want to get sale from specific network, then pass the network name in this parameter.
MerchantNameOptionalIf you want to get sale from specific merchant, then pass the network name in this parameter.
StatusTRACKED | CONFIRMED | DECLINEOptionalUse to filter sale by sale status.
PageNoOptionalBy default API returns all data. But data required in paging, then pass page no. With this parameter PageSize parameter is required.
PageSizeOptionalPass the value if the data required in paging. This parameter used to set the number of records in a page.

Example:

  1. Get all sales API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetSales/Json
  2. Get all sales of page size 25. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetSales/Json?PageNo=1&PageSize=25
  3. Get all sales joined/added to the iDealFeeds account, of page size 25. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetSales/Json? RelationType=JOINED&PageNo=1&PageSize=25
  4. Filter sales by network name and get results in page size of 25. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetSales/Json?NetworkName=Optimize &PageNo=1&PageSize=25
  5. Filter sales by network name, merchant name and get results in page size of 25. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetSales/Json?NetworkName=Optimize &MerchantName=Zalora&PageNo=1&PageSize=25
  6. Filter sales by network name, merchant name and status and get results in page size of 25. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetSales/Json?NetworkName=Optimize &MerchantName=Zalora&Status=TRACKED&PageNo=1&PageSize=25

User same as above for XML and CSV format, only need to replace data format parameter values i.e.replace json by xml or csv.

Access Clicks

This method is accessible to Data Subcribers signed up to the revenue share plan.

API Request URL Format: http://api.idealfeeds.com/{APIKEY}/{MethodName}/{DataFormat}? PageNo={PageNo}&PageSize={PageSize}

ParameterValueTypeNote
API KEY----MandatoryShould have valid and active APIKey
MethodNameGetClicksMandatory
DataFormatJSON | XML | CSVMandatoryOnly one data type is allowed at a time. Please use JSON or XML or CSV
PageNoOptionalBy default API returns all data. But data required in paging, then pass page no. With this parameter PageSize parameter is required.
PageSizeOptionalPass the value if the data required in paging. This parameter used to set the number of records in a page.

Example:

  1. Get all clicks API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetClicks/Json
  2. Get all clicks of page size 25. API Request URL: http://api.idealfeeds.com/ef8f361d98222ca9de12814223aff0ac/GetClicks/Json?PageNo=1&PageSize=25

User same as above for XML and CSV format, only need to replace data format parameter values i.e.replaces json by xml or csv.

0+
affiliate networks

0+
Merchants

0+
Coupons

7
countries