Skip to content

Latest commit

 

History

History
260 lines (219 loc) · 8.31 KB

README.md

File metadata and controls

260 lines (219 loc) · 8.31 KB
Raw

Polychemy's Embedable App. BETA.

Polychemy's Embeddable App Implementation.

Polychemy's Embeddable apps allows any online retailer to embed Polcyhemy's customizable jewelry display.
Customers can customize thier own products and purchase directly of your site, with out leaving your web site.
The apps can be hooked up to the your shopping cart, ensuring a much better user expirence for your customers.

By Using our Apps, you agree to our Privacy Policy and [Terms & Conditions] (http://www.polychemy.com/Policies.php)

How Does it Work?

here's a brief overview of the app implimentation.
  • Embed the Polychemy App to your web site, with our simple I-Frame Code, and configure settings.
  • When the customers presses "Add To Cart", A POST request is send to your shopping cart page, with product details and image. Customization Data is also sent in JSON.
  • Once your customers completes the check out process on your site and confirms payment. You place the order with a POST request to our API, forwarding the product details and customization data. Multiple products can be sent in one cart.
  • Finally , once payment is made, we will begin manufacturing.

Step 1 - Embed Iframe App.

Add this Code anywhere in the BODY Tags of your HTML. ```javascript <iframe src="" width="1100" height="1200" scrolling="no" id="iframeEmbed"></iframe> <script type="text/javascript"> //Set Up variables For Embedable App./// var USER = "[ACCESSCODE]"; var productName = "Roman Name Ring"; var shoppingcart = "http://yoursite.com/FakeShoppingCart.php"; var currency = "USD"; //var shoppingcart = ""; var buyButton = "Add To Cart"; //////////////////////////////////////////////////////////// var Poly_embed = document.getElementById("iframeEmbed"); Poly_embed.src = "http://www.polychemy.com/Jewelry.php?name="+productName+"&embed=true&User="+USER+"&shoppingCart="+encodeURIComponent(shoppingcart)+"&buyButton="+encodeURIComponent(buyButton)+"¤cy="+currency; </script> ``` Replace the [Access code] with the one issued to you.
productName variable is the name of the default product. You can change this to which ever you prefer. You can also use the product SKU.
shoppingcart variable is most important. This is your shopping cart page that will recieve the product Details. Leave this empty if you prefer to use Polychemy.com's shopping cart (var shoppingcart = "";) .
buyButton - Customize the checkout button. Default is "Add To Cart".
currency - The Default Currency.

Step 2 - Create Your Shopping Cart.

After the user has finished customizing thier products on the app, and is ready to check out.
The "Check Out" Button is pressed. Variables will be sent via POST Method to your shopping cart you specified in the previous step.
POST Variables Details.

This data should be stored on your shopping cart database.

Step 3 - Send the order to Polychemy

Once your customers has finsihed the checkout process, and payment has been made. You will have to send us the order, and customization details from the previous step.

Here is a PHP example of placing an order with our order.php API.

<?php
//Set Customer data and shipping details.
//We Will ship the product to this address.
$CustomerData = new stdClass();
$CustomerData->email = "customer@gmail.com";
$CustomerData->street = "Ave 12";
$CustomerData->city = "New York";
$CustomerData->state = "New York";
$CustomerData->zip = "123232";
$CustomerData->country = "United Statesdsf";
$CustomerData->name = "John Doe";
$CustomerData->hpnumber = "383748743";
$CustomerData->occasion = "none";
//Leave these variables blank.
$CustomerData->gender = "none";
$CustomerData->forwho = "none";
$CustomerData->coupon = "";
$CustomerData->cdtoken = "";

//send polcyehmy invoice. if false, no invoice will be sent.
//If oyu want to send your own invoice, then keep this as FALSE.
$CustomerData->sendinvoice = false;

//Identification Variables
$referalData = new stdClass();

///***Replace ACCESS ID with the Access ID you were given.
$referalData->referalID = "[ACCESS ID]";
$referalData->type = "[ACCESS ID]";

///Add Product Data into shopping cart array.
//This product Data is given to you from the previous step. Product data contains the customization settings for each product.
//If there are multiple products in the shopping cart, then add all to the array.
$ShoppingCart = array();
array_push($ShoppingCart, json_decode($_POST["ProductDATA"]));



$customizationData = new stdClass();
$customizationData->customerData = $CustomerData;
$customizationData->ShoppingCart = $ShoppingCart;

//**Set User ID. The user ID is given to you from the previous setp. Any USER ID, from any product in the cart will be fine.
$customizationData->ID = $_POST["ID"];

//get referal information if there's any
$customizationData->referal = $referalData;	
//set payment type.
$customizationData->paymentType = "ExternalCart";

//** This is your Secret Key.
$customizationData->secret = "[SECRET KEY]";


//CURL POST Script.
//set POST variables and URL.
$url = 'https://www.polychemy.com/php/Order.php';
$fields = array(
						'customerData' => urlencode(json_encode($customizationData)),
						'command' => urlencode("addOrder")
				);

//url-ify the data for the POST
$fields_string="";
foreach($fields as $key=>$value) { $fields_string .= $key.'='.$value.'&'; }
rtrim($fields_string, '&');

//open connection
$ch = curl_init();

//set the url, number of POST vars, POST data
curl_setopt($ch,CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST, count($fields));
curl_setopt($ch,CURLOPT_POSTFIELDS, $fields_string);

curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);

//execute post
$result = curl_exec($ch);


//close connection
curl_close($ch);
echo $result;
?>

Here's a JSON example request.
You will have to send the following JSON request to POST variable 'customerData'.
And a 'addOrder' string to POST variable 'command'.
Please make sure you stringify the data and URL encode it before sending it over to our system.

{
	"customerData":{
		"email":"aaron.issac@gmail.com",
		"street":"Ave 12",
		"city":"New York",
		"state":"New York",
		"zip":"123232",
		"country":"United States",
		"name":"John Doe",
		"hpnumber":"383748743",
		"gender":"none",
		"forwho":"none",
		"occasion":"none",
		"coupon":"",
		"cdtoken":"",
		"sendinvoice":false
	},
	"ShoppingCart":[{ JSON ENCODED PRODUCT DATA }],
	"ID":"641567956",
	"referal":{
		"referalID":"[ACCESS ID]",
		"type":"[ACCESS ID]"
	},
	"paymentType":"ExternalCart",
	"secret":"polychemy"
}

Here's another JSON Example. This time with a test product (from productDATA). This is how your JSON should look when you pass the data to us. Be sure to serealize the JSON request before sending it to us

{
	"customerData":{
	"email":"aaron.issac@gmail.com",
	"street":"Ave 12",
	"city":"New York",
	"state":"New York",
	"zip":"123232",
	"country":"United States",
	"name":"John Doe",
	"hpnumber":"383748743",
	"gender":"none",
	"forwho":"none",
	"occasion":"none",
	"coupon":"",
	"cdtoken":"",
	"sendinvoice":false
	},
	"ShoppingCart":[
		{
		"type":"Roman Name Ring",
		"sku":"ROMANRING",
		"arg":[
		"small",
		"Sterling_Silver",
		"6"
		],
		"argvalue":[
		"Custom Text",
		"Material",
		"Ring Size"
		],
		"commandlist":[
		"TEXT",
		"MATERIAL",
		"RINGSIZE"
		],
		"RAWcommandlist":[
		"TEXT:7:Love:CHECKCHAR",
		"MATERIAL:ALL",
		"RINGSIZE:ALL"
		],
		"priceDisplay":121.58,
		"folder":"3568471218459308000",
		"itemnum":"3568471218459308000",
		"image":"http:\/\/polychemy3d.com\/ModelDATABASE.php?getfile=JPG&ID=3568471218459308000",
		"volume":"0.3335311903633674",
		"price":129.99
		}
	],
"ID":"641567956",
"referal":{
	"referalID":"[ACCESS ID]",
	"type":"[ACCESS ID]"
}

If everyhting is sucessful you will get the following JSON response:

{"result":"OK"}

The order has been placed and we will begin manufacturing, ONLY after payment is made with us.
Payment must be made in USD only.