API : Catalog v 1.29

Partner: Bigbarnmusic

Table Of Content

All Possible Actions

doc

This API can be used to fetch product information and list promotions from the Plugivery Catalog, enabling our partners to quickly and conveniently create attractive product pages.

Restrictions

Rate Limits

When using the API, you must make sure that you do not exceed the following Limits.
Queries above the limits will be refused with the relevant Error Code (see below):

Name	Content
Max Reads / day	300
Max Reads / month	4000

Name	Content
Current Reads / day	2
Current Reads / month	2

IP Restricted

Most of these API actions can only be reached from authorized IPs. You can define them here.

Your current authorized IPs are :

208.67.20.14

Request / Response

Request Parameters

Here are the GET parameters used to query the API :

This is a private API so you must always use the 'token' authentication parameter.

Required Parameters
Name	Type	Description
token	String	Authentication Token
act	String	Action to perform (see "All Possible Actions" below)
Optional Parameters
Name	Type	Description
print	Integer	Set to '1' to display the JSON array response as HTML. (In 'doc' mode, set it to '2' to show an HTML version)

JSON Response

For each request, the API will return a JSON array with all the following fields :

Returned Fields
Name	Type	Content
request	Array	Received Parameters
data	Array	The resulting data

error	Integer	Error code (0 if OK)
error_txt	String	A text description of the error

api_version	String	API Version
Cache Information
cache_since	Unix Timestamp	The date when the object was cached
cache_until	Unix Timestamp	The date when the object will be refreshed
now	Unix Timestamp	Current Date

When a valid response is found, the API will return an HTTP code 200 (found), and an error code of 0 (no error).
When an error occurs, the HTTP code and error code returned will be one of the followings :

Returned Error Codes
Name	Content
0	OK
401	Unauthorized
403	Forbidden
404	Not Found
451	Unauthorized IP Address (18.118.164.151)
453	Invalid Token
455	Missing Required Parameter
461	Access Revoked
462	No Result
463	Account Auto Created
472	Over Daily Read Limit
473	Over Monthly Read Limit
474	Over Total Read Limit
477	Over Daily Write Limit
478	Over Monthly Write Limit
479	Over Total Write Limit
501	Not Implemented
503	Service Unavailable

All Possible Actions

Action : listRate limits, Accesses are logged.

List Products.

Example: https://api.plugivery.com/catalog/?act=list&token=9d42e02c534c1c9d381fe90e1e370430

Required Parameters
Name	Type	Description	Example
since	String	all: All products (default) day: Products changed since one Day week: Products changed since one Week month: Products changed since one Month	since=all
Optional Parameters
Name	Type	Description
brand_id	Integer	Filter by Brand ID. (To list all available Brand IDs, you can use the 'list_brands' action)

Returned Data Fields
Name	Type	Content
id	Integer	Product ID
date	Unix Timestamp	Last modified Date
msrp	Float	MSRP : Manufacturer's Suggested Retail Price
map	Float	Current MAP Price : Minimum Advertised Price (follows promotions)
cost	Float	Current Dealer Cost Price (follows promotions)
reg_map	Float	Regular MAP Price : Minimum Advertised Price
reg_cost	Float	Regular Dealer Cost Price

Action : getRate limits, Accesses are logged.

Get one Product.

Example: https://api.plugivery.com/catalog/?act=get&token=9d42e02c534c1c9d381fe90e1e370430

Required Parameters
Name	Type	Description	Example
id	Integer	Product ID	id=1147

Returned Data Fields
Name	Type	Content
id	Integer	Product ID
name	String	Name
desc	String	Description
date	Unix Timestamp	Last modified Date
msrp	Float	MSRP : Manufacturer's Suggested Retail Price
map	Float	Current MAP Price : Minimum Advertised Price (follows promotions)
cost	Float	Current Dealer Cost Price (follows promotions)
reg_map	Float	Regular MAP Price : Minimum Advertised Price
reg_cost	Float	Regular Dealer Cost Price
url	String	Product URL
img	String	Image URL : You can copy the image but NEVER HOTLINK to it !
brand_id	Integer	Brand ID. (To list all available Brand IDs, use the 'list_brands' action)
brand_name	String	Brand Name
cat_id	Integer	Category ID. (To list all available Category IDs, use the 'list_cats' action)
cat_name	String	Category Name

Action : list_catsRate limits, Accesses are logged.

List All Products Categories.

Example: https://api.plugivery.com/catalog/?act=list_cats&token=9d42e02c534c1c9d381fe90e1e370430

Returned Data Fields
Name	Type	Content
id	Integer	Category ID
name	String	Category Name

Action : list_brandsRate limits, Accesses are logged.

List All Brands.

Example: https://api.plugivery.com/catalog/?act=list_brands&token=9d42e02c534c1c9d381fe90e1e370430

Returned Data Fields
Name	Type	Content
id	Integer	Brand ID
name	String	Brand Name
url	String	Brand URL
img	String	Brand Image URL : You can copy the images but NEVER HOTLINK to them !

Action : list_promotionsRate limits, Accesses are logged.

List Upcoming, Current, Closed and Recent Promotions.

Example: https://api.plugivery.com/catalog/?act=list_promotions&token=9d42e02c534c1c9d381fe90e1e370430

Optional Parameters
Name	Type	Description	Example
state	Integer	0: Future Promotions 1: Current Promotions 2: Closed Promotions (Grace Period is running) 3: Past Promotions	state=1
brand_id	Integer	Filter by Brand ID. (To list all available Brand IDs, you can use the 'list_brands' action)

Returned Data Fields
Name	Type	Content	Description
id	Integer	Promotions ID
state	Integer	State	0: Future Promotion 1: Current Promotion 2: Closed Promotion (Grace Period is running) 3: Past Promotion
start	Unix Timestamp	Start Date
end	Unix Timestamp	End Date
prod_id	Integer	Product ID
msrp	Float	MSRP : Manufacturer's Suggested Retail Price
promo_map	Float	Promo MAP Price : Minimum Advertised Price
promo_cost	Float	Promo Dealer Cost Price
reg_map	Float	Regular MAP Price : Minimum Advertised Price
reg_cost	Float	Regular Dealer Cost Price

Action : infoNo rate limits, Accesses are not logged.

Get current API Information.

Example: https://api.plugivery.com/catalog/?act=info

Action : docNo rate limits, Accesses are not logged.

Get current API Self Documentation.

Example: https://api.plugivery.com/catalog/?act=doc