OneShopAPI.php
From Developer's API
(Difference between revisions)
(New page: <pre> <?php # OneShopAPI: PHP wrapper class for 1ShoppingCart.com API # Author: 1ShoppingCart.com class OneShopAPI { var $_merchantId = ""; var $_merchantKey = ""; var $_apiUri = "";...) |
|||
| Line 19: | Line 19: | ||
} | } | ||
| − | # | + | # This method uses the curl object to make |
| − | + | # a POST request to the api and return the response | |
| − | + | # from the API | |
| − | + | ||
| − | + | ||
| − | + | ||
function SendHttpRequest($uri, $request_body) | function SendHttpRequest($uri, $request_body) | ||
{ | { | ||
| Line 41: | Line 38: | ||
} | } | ||
| + | # This method will call the SendHttpRequest method | ||
| + | # after appending the proper information to the uri | ||
| + | # and creating the request body | ||
function ApiRequest($path, $parameters = "") | function ApiRequest($path, $parameters = "") | ||
{ | { | ||
| Line 50: | Line 50: | ||
} | } | ||
| + | # This method will take a properly formatted api uri | ||
| + | # and create the response body then call the http request method | ||
function XLinkApiRequest($xlink, $parameters = "") | function XLinkApiRequest($xlink, $parameters = "") | ||
{ | { | ||
| Line 85: | Line 87: | ||
} | } | ||
| − | |||
| − | |||
function GetOrdersList() | function GetOrdersList() | ||
{ | { | ||
| Line 97: | Line 97: | ||
} | } | ||
| − | |||
| − | |||
function GetProductsList() | function GetProductsList() | ||
{ | { | ||
| Line 108: | Line 106: | ||
return($this->ApiRequest("/PRODUCTS/" . $productId . "/READ")); | return($this->ApiRequest("/PRODUCTS/" . $productId . "/READ")); | ||
} | } | ||
| − | |||
| − | |||
function GetClientsList() | function GetClientsList() | ||
Revision as of 14:08, 29 May 2008
<?php
# OneShopAPI: PHP wrapper class for 1ShoppingCart.com API
# Author: 1ShoppingCart.com
class OneShopAPI
{
var $_merchantId = "";
var $_merchantKey = "";
var $_apiUri = "";
var $_apiParameters;
function OneShopAPI($merchantId, $merchantKey, $apiUri)
{
$this->_merchantId = $merchantId;
$this->_merchantKey = $merchantKey;
$this->_apiUri = $apiUri;
}
# This method uses the curl object to make
# a POST request to the api and return the response
# from the API
function SendHttpRequest($uri, $request_body)
{
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $uri);
curl_setopt($ch, CURLOPT_POSTFIELDS, $request_body);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('X-POST_DATA_FORMAT: xml'));
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); # TODO - SET THIS TO true FOR PRODUCTION
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$data = curl_exec($ch);
curl_exec($ch);
$err = curl_error($ch);
if ($err)
return $err;
return $data;
}
# This method will call the SendHttpRequest method
# after appending the proper information to the uri
# and creating the request body
function ApiRequest($path, $parameters = "")
{
$uri = $this->_apiUri."/API/".$this->_merchantId.$path;
$request_body = $this->CreateRequestString();
$result = $this->SendHttpRequest($uri, $request_body);
return($result);
}
# This method will take a properly formatted api uri
# and create the response body then call the http request method
function XLinkApiRequest($xlink, $parameters = "")
{
$request_body = $this->CreateRequestString();
$result = $this->SendHttpRequest($xlink, $request_body);
return($result);
}
function CreateRequestString()
{
$request_body = "<Request><Key>".$this->_merchantKey."</Key>".$this->ParseApiParameters($this->_parameters)."</Request>";
return $request_body;
}
function ParseApiParameters($parameters)
{
$request_payload = "";
if ((!empty($parameters)) && (is_array($parameters)))
{
foreach($parameters as $key => $value)
{
if (!is_array($value))
{
$request_payload .= ("<".$key.">".$value."</".$key.">\r\n");
}
else
{
$request_payload .= "<".$key.">\r\n";
$request_payload .= $this->create_request($value);
$request_payload .= "</".$key.">\r\n";
}
}
}
return $request_payload;
}
function GetOrdersList()
{
return($this->ApiRequest("/ORDERS/LIST"));
}
function GetOrderById($orderId)
{
return($this->ApiRequest("/ORDERS/" . $orderId . "/READ"));
}
function GetProductsList()
{
return($this->ApiRequest("/PRODUCTS/LIST"));
}
function GetProductById($productId)
{
return($this->ApiRequest("/PRODUCTS/" . $productId . "/READ"));
}
function GetClientsList()
{
return($this->ApiRequest("/CLIENTS/LIST"));
}
function GetClientById($clientId)
{
return($this->ApiRequest("/CLIENTS/". $clientId ."/READ"));
}
function GetErrorsList()
{
return($this->ApiRequest("/ERRORS/LIST"));
}
function GetAvailableApiMethods()
{
return($this->ApiRequest(""));
}
}
?>