PHP Examples (Rest API) - Revision history

Appscp: /* PHP */

2014-11-05T23:02:35Z

‎PHP

James.morgan: /* PHP */

2011-04-11T03:30:00Z

‎PHP

James.morgan: /* PHP */

2010-10-01T18:00:38Z

‎PHP

James.morgan: /* PHP */

2010-10-01T17:50:20Z

‎PHP

Zhen.wei: new php example

2010-05-19T20:29:03Z

new php example

Show changes

Kevin.lin: Sync to latest.

2010-03-29T15:25:00Z

Sync to latest.

New page

=== PHP ===

<pre>
<?php
class WebMethods
{
const VERSION = 'v0';
const SERVER_HOST = 'api.emailsrvr.com';

public function get($url_string, $format)
{
$url = $this->getUrl($url_string);
$headers = array();
$this->signRequest($headers);
$this->assignFormat($headers, $format);
$session = curl_init($url);
curl_setopt($session, CURLOPT_HEADER, true);
curl_setopt($session, CURLOPT_HTTPHEADER, $headers);
curl_setopt($session, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($session);
curl_close($session);

echo $response;
}

public function post($url_string, $fields, $format)
{
$url = $this->getUrl($url_string);
$headers = array();
$this->signRequest($headers);
$this->assignFormat($headers, $format);
$session = curl_init($url);

curl_setopt($session, CURLOPT_HEADER, true);
curl_setopt($session, CURLOPT_HTTPHEADER, $headers);
curl_setopt($session, CURLOPT_POST, true);
curl_setopt($session, CURLOPT_POSTFIELDS, $fields);
curl_setopt($session, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($session);
curl_close($session);

echo $response;
}

public function put($url_string, $fields, $format)
{
$url = $this->getUrl($url_string);
$headers = array();
$this->signRequest($headers);
$this->assignFormat($headers, $format);
$session = curl_init($url);

curl_setopt($session, CURLOPT_HEADER, true);
curl_setopt($session, CURLOPT_HTTPHEADER, $headers);
curl_setopt($session, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($session, CURLOPT_POSTFIELDS, $fields);
curl_setopt($session, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($session);
curl_close($session);

echo $response;
}

public function delete($url_string, $format)
{
$url = $this->getUrl($url_string);
$headers = array();
$this->signRequest($headers);
$this->assignFormat($headers, $format);
$session = curl_init($url);

curl_setopt($session, CURLOPT_HEADER, true);
curl_setopt($session, CURLOPT_HTTPHEADER, $headers);
curl_setopt($session, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($session, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($session);
curl_close($session);

echo $response;
}

public function signRequest(&$headers)
{
$user_agent = 'Api Test';
$time_stamp = 'YYYYMMDDHHmmss';
$api_key = 'XXXXXXXXXXXXXXXXXXXX';
$secret_key = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';

$data_to_sign = $api_key . $user_agent . $time_stamp . $secret_key;
$signature = base64_encode(sha1($data_to_sign, true));

$headers[] = "User-Agent: $user_agent";
$headers[] = "X-Api-Signature: $api_key:$time_stamp:$signature";
}

public function assignFormat(&$headers, $format)
{
$headers[] = "Accept: $format";
}

public function getUrl($url_string)
{
$url = 'http://' . self::SERVER_HOST . '/' . self::VERSION . $url_string;
return $url;
}
}
?>
</pre>

<pre>
<?php
require_once 'WebMethods.php';

$client = new WebMethods();

$url = '/customers';
$form = 'name=new customer&referenceNumber=1000';
$format = 'text/xml';

$client->post($url, $form, $format);
?>
</pre>

@@ Line 1: / Line 1: @@
 === PHP ===
-An API library for performing basic operations. This requires the curl and pecl_http PHP extensions:
+An API library for performing basic operations. Save the following to a file named <code>ApiClient.php</code>:
 <pre>
 <?php
 /**
-  * Needs PHP's curl and pecl_http extensions.
+  * Simple client class for consuming the Email & Apps REST API
+  *
-  * All results are returned as an HttpMessage object.
+  * Pre-requisites:
   */
-class ApiServer
+class ApiClient
+{
      const USER_KEY = 'xxxxxxxxxxxxxxxxxxxx';
@@ Line 15: / Line 24: @@
      const USER_AGENT = 'PHP Demo Client';
-     const VERSION = 'v0';
+     const VERSION = 'v1';
      const SERVER_HOST = 'api.emailsrvr.com';
@@ Line 43: / Line 52: @@
+     {
          $curl_session = self::construct_session($url_string, array());
-−
          curl_setopt($curl_session, CURLOPT_CUSTOMREQUEST, 'PUT');
          curl_setopt($curl_session, CURLOPT_POSTFIELDS, $fields);
@@ Line 66: / Line 75: @@
          curl_close($curl_session);
-         return new HttpMessage($response);
+         return $response;
+     }
@@ Line 76: / Line 85: @@
          $curl_session = curl_init($url);
-         curl_setopt($curl_session, CURLOPT_HEADER, true);
+         curl_setopt($curl_session, CURLOPT_VERBOSE, false); //set to true for debug
          curl_setopt($curl_session, CURLOPT_HTTPHEADER, $headers);
          curl_setopt($curl_session, CURLOPT_RETURNTRANSFER, true);
          return $curl_session;
@@ Line 101: / Line 113: @@
      private function construct_uri($url_string)
+     {
-         $url = 'http://' . self::SERVER_HOST . '/' . self::VERSION . $url_string;
+         $url = 'https://' . self::SERVER_HOST . '/' . self::VERSION . $url_string;
          return $url;
+     }
+}
 </pre>
@@ Line 113: / Line 124: @@
 <?php
 header('Content-Type:  text/plain');
-require_once 'ApiServer.php';
+require_once 'ApiClient.php';
-$client = new  ApiServer();
+$client = new  ApiClient();
 $response = $client->get(
@@ Line 121: / Line 132: @@
      'text/xml');
-echo  $response->getResponseCode() . "\r\n" .
+echo  $response . "\r\n";
 ?>
 </pre>
@@ Line 132: / Line 141: @@
 <?php
 header('Content-Type:  text/plain');
-require_once 'ApiServer.php';
+require_once 'ApiClient.php';
-$client = new  ApiServer();
+$client = new  ApiClient();
 $fields  = Array(
@@ Line 142: / Line 151: @@
 $response = $client->post(
      '/customers/me/domains/newdomain.com',
-     $fields);
+     $fields,
-echo  $response->getResponseCode() . "\r\n" .
+echo  $response . "\r\n";
 ?>
 </pre>
@@ Line 155: / Line 163: @@
 <?php
 header('Content-Type:  text/plain');
-require_once 'ApiServer.php';
+require_once 'ApiClient.php';
-$client = new  ApiServer();
+$client = new  ApiClient();
 $fields= Array(
@@ Line 167: / Line 175: @@
 $response = $client->put(
      '/customers/me/domains/testdomain.com/rs/mailboxes/test.mailbox',
-     $fields);
+     $fields,
-echo  $response->getResponseCode() . "\r\n" .
+echo  $response . "\r\n";
 ?>
 </pre>
@@ Line 180: / Line 187: @@
 <?php
 header('Content-Type: text/plain');
-require_once 'ApiServer.php';
+require_once 'ApiClient.php';
-$client = new ApiServer();
+$client = new ApiClient();
 $format = 'application/json';
 $domain = 'apiPagingTest.com';
@@ Line 190: / Line 197: @@
 $response = $client->get($url, $format);
-$body = $response->getBody();
+echo $response . "\n";
-$result = json_decode($response->getBody());
+$result = json_decode($response);
 // check results
@@ Line 209: / Line 215: @@
                              . $pageSize . '&offset=' . $offset;
      $response = $client->get($url, $format);
-     echo $response->getBody(). "\n";
+     echo $response . "\n";
+}

@@ Line 28: / Line 28: @@
+     }
-     public function post($url_string, $fields)
+     public function post($url_string, $fields, $format)
+     {
-         $curl_session = self::construct_session($url_string, array());
+        $headers = array("Accept: $format");
          curl_setopt($curl_session, CURLOPT_POST, true);
@@ Line 37: / Line 38: @@
          $http_message = self::send_request($curl_session);
          return $http_message;
-−
+    }
      public function put($url_string, $fields)

@@ Line 148: / Line 148: @@
 ?>
 </pre>
 A get with paging:

@@ Line 38: / Line 38: @@
          return $http_message;
+      }
      public function delete($url_string)