This API is used to receive information about your user's recommendations and transactions.
If you choose to use this API you must first produce a 'secret' key that would be used to identify your request.
The 'secret' can be produced
here.
Note that the 'secret' is used to identify you, so you should keep it safe and on a none public area on your server.
Make an https request to this URL:
https://b-buzzy.com/API/getInfo/index.php.
If you are working on B-buzzy's sandbox than the url is:
https://sandbox.b-buzzy.com/API/getInfo/index.php.
Use the following POST NVP parameters:
Parameter name | Details |
sellerId | The Id provided by B-buzzy |
sellerSecret | Your 'secret' |
type | To receive the data regarding the user's recommendations use "recommendations" |
userEmail | The user's email address. |
* All of the parameters passed must be URL encoded.
The response for the request is a XML file as follows:
Node name | Details |
fieldsData | Holds all the names and values the parameters on your request. For each field (besides "sellerSecret" for security), a node of 'name' and 'value' will be provided. |
message | Holds a message regarding your request. |
recommendations | Holds the all of the response data for the user's recommendations. |
recommendation | Holds the response data for each user's recommendation. |
recommendationText | Recommendation's text. |
recommendationMedia | Media used by the user to send the recommendation (eg. facebook, email ..). |
recommendationTime | GMT time the recommendation was sent. |
recommendationViewCount | Count of the times the recommedation was viewed. |
recommendationPurchasesCount | Count of the times a purchase was made through the recommedation. |
transactionId | Transaction's data - see details on NVP data dictionary |
sellerProductId | Transaction's data - see details on NVP data dictionary |
productName | Transaction's data - see details on NVP data dictionary |
productCategory | Transaction's data - see details on NVP data dictionary |
manufacturer | Transaction's data - see details on NVP data dictionary |
productPrice | Transaction's data - see details on NVP data dictionary |
priceCurrency | Transaction's data - see details on NVP data dictionary |
productQuantity | Transaction's data - see details on NVP data dictionary |
productTotalPrice | Transaction's data - see details on NVP data dictionary |
productURL | Transaction's data - see details on NVP data dictionary |
imageURL | Transaction's data - see details on NVP data dictionary |
userEmail | Transaction's data - see details on NVP data dictionary |
Here is a sample file that illustrates the structure of the XML response:
<?xml version="1.0" encoding="UTF-8"?>
<response>
<fieldsData>
<field>
<name>sellerId</name>
<value>123abc</value>
</field>
<field>
<name>type</name>
<value>recommendations</value>
</field>
<field>
<name>userEmail</name>
<value>purchasing_user@gmail.com</value>
</field>
.....
</fieldsData>
<message>displaying 5 records</message>
<recommendations>
<recommendation>
<recommendationText>I got a new iphone :-)</recommendationText>
<recommendationMedia>facebook</recommendationMedia>
<recommendationTime>10/25/2011 15:33:31</recommendationTime>
<recommendationViewCount>45</recommendationViewCount>
<recommendationPurchasesCount>2</recommendationPurchasesCount>
<transactionId>2121wAj40622</transactionId>
<sellerProductId>2113A</sellerProductId>
<productName>Iphone 4 16GB</productName>
<productCategory>Smart phones</productCategory>
<manufacturer>Apple inc.</manufacturer>
<productPrice>300</productPrice>
<priceCurrency>USD</priceCurrency>
<productQuantity>1</productQuantity>
<productTotalPrice>300</productTotalPrice>
<productURL>http://www.yoursite.com/?item=123</productURL>
<imageURL>http://www.yoursite.com/img/1.jpg</imageURL>
<userEmail>purchasing_user@gmail.com</userEmail>
</recommendation>
<recommendation>
.....
</recommendation>
.....
<recommendations>
</response>