documentation/manual/en/module_specs/Zend_Service_StrikeIron-Overview.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.service.strikeiron">
   4     <title>Zend_Service_StrikeIron</title>
   5
   6     <para>
   7         <classname>Zend_Service_StrikeIron</classname> provides a <acronym>PHP</acronym> 5 client to
   8         StrikeIron web services. See the following sections:
   9     </para>
  10
  11     <para>
  12         <itemizedlist>
  13             <listitem><para><xref linkend="zend.service.strikeiron" /></para></listitem>
  14         </itemizedlist>
  15
  16         <itemizedlist>
  17             <listitem>
  18                 <para><xref linkend="zend.service.strikeiron.bundled-services" /></para>
  19             </listitem>
  20         </itemizedlist>
  21
  22         <itemizedlist>
  23             <listitem>
  24                 <para><xref linkend="zend.service.strikeiron.advanced-uses" /></para>
  25             </listitem>
  26         </itemizedlist>
  27     </para>
  28
  29     <sect2 id="zend.service.strikeiron.overview">
  30         <title>Overview</title>
  31
  32         <para>
  33             <ulink url="http://www.strikeiron.com">StrikeIron</ulink>
  34             offers hundreds of commercial data services ("Data as a Service")
  35             such as Online Sales Tax, Currency Rates, Stock Quotes, Geocodes, Global
  36             Address Verification, Yellow/White Pages, MapQuest Driving Directions,
  37             Dun &amp; Bradstreet Business Credit Checks, and much, much more.
  38         </para>
  39
  40         <para>
  41             Each StrikeIron web service shares a standard <acronym>SOAP</acronym> (and REST)
  42             <acronym>API</acronym>, making it easy to integrate and manage multiple services.
  43             StrikeIron also manages customer billing for all services in a single
  44             account, making it perfect for solution providers. Get
  45             started with free web services at
  46             <ulink url="http://www.strikeiron.com/sdp">http://www.strikeiron.com/sdp</ulink>.
  47         </para>
  48
  49         <para>
  50             StrikeIron's services may be used through the
  51             <ulink url="http://us.php.net/soap">PHP 5 <acronym>SOAP</acronym> extension</ulink>
  52             alone. However, using StrikeIron this way does not give an ideal
  53             <acronym>PHP</acronym>-like interface. The
  54             <classname>Zend_Service_StrikeIron</classname> component provides a lightweight layer on
  55             top of the <acronym>SOAP</acronym> extension for working with StrikeIron services in a
  56             more convenient, <acronym>PHP</acronym>-like manner.
  57         </para>
  58
  59         <note>
  60             <para>
  61                 The <acronym>PHP</acronym> 5 <acronym>SOAP</acronym> extension must be installed and
  62                 enabled to use <classname>Zend_Service_StrikeIron</classname>.
  63             </para>
  64         </note>
  65
  66         <para>
  67             The <classname>Zend_Service_StrikeIron</classname> component provides:
  68
  69             <itemizedlist>
  70                 <listitem>
  71                     <para>
  72                         A single point for configuring your StrikeIron authentication credentials
  73                         that can be used across many StrikeIron services.
  74                     </para>
  75                 </listitem>
  76
  77                 <listitem>
  78                     <para>
  79                         A standard way of retrieving your StrikeIron subscription information
  80                         such as license status and the number of hits remaining to a service.
  81                     </para>
  82                 </listitem>
  83
  84                 <listitem>
  85                     <para>
  86                         The ability to use any StrikeIron service from its WSDL without
  87                         creating a <acronym>PHP</acronym> wrapper class, and the option of creating
  88                         a wrapper for a more convenient interface.
  89                     </para>
  90                 </listitem>
  91
  92                 <listitem>
  93                     <para>
  94                         Wrappers for three popular StrikeIron services.
  95                     </para>
  96                 </listitem>
  97             </itemizedlist>
  98         </para>
  99     </sect2>
 100
 101     <sect2 id="zend.service.strikeiron.registering">
 102         <title>Registering with StrikeIron</title>
 103
 104         <para>
 105             Before you can get started with <classname>Zend_Service_StrikeIron</classname>, you must
 106             first <ulink url="http://strikeiron.com/Register.aspx">register</ulink> for a
 107             StrikeIron developer account.
 108         </para>
 109
 110         <para>
 111             After registering, you will receive a StrikeIron username and password.
 112             These will be used when connecting to StrikeIron using
 113             <classname>Zend_Service_StrikeIron</classname>.
 114         </para>
 115
 116         <para>
 117             You will also need to <ulink
 118                 url="http://www.strikeiron.com/ProductDetail.aspx?p=257">sign up</ulink>
 119             for StrikeIron's Super Data Pack Web Service.
 120         </para>
 121
 122         <para>
 123             Both registration steps are free and can be done relatively quickly through
 124             the StrikeIron website.
 125         </para>
 126     </sect2>
 127
 128     <sect2 id="zend.service.strikeiron.getting-started">
 129         <title>Getting Started</title>
 130
 131         <para>
 132             Once you have <ulink url="http://strikeiron.com/Register.aspx">registered</ulink>
 133             for a StrikeIron account and signed up for the
 134             <ulink url="http://www.strikeiron.com/ProductDetail.aspx?p=257">Super Data Pack</ulink>,
 135             you're ready to start using <classname>Zend_Service_StrikeIron</classname>.
 136         </para>
 137
 138         <para>
 139             StrikeIron consists of hundreds of different web services.
 140             <classname>Zend_Service_StrikeIron</classname> can be used with many of these services
 141             but provides supported wrappers for three of them:
 142         </para>
 143
 144         <itemizedlist>
 145             <listitem>
 146                 <para>
 147                     <link
 148                         linkend="zend.service.strikeiron.bundled-services.zip-code-information">ZIP
 149                         Code Information</link>
 150                 </para>
 151             </listitem>
 152
 153             <listitem>
 154                 <para>
 155                     <link
 156                         linkend="zend.service.strikeiron.bundled-services.us-address-verification">US
 157                         Address Verification</link>
 158                 </para>
 159             </listitem>
 160
 161             <listitem>
 162                 <para>
 163                     <link
 164                         linkend="zend.service.strikeiron.bundled-services.sales-use-tax-basic">Sales
 165                         &amp; Use Tax Basic</link>
 166                 </para>
 167             </listitem>
 168         </itemizedlist>
 169
 170         <para>
 171             The class <classname>Zend_Service_StrikeIron</classname> provides a simple way
 172             of specifying your StrikeIron account information and other options in
 173             its constructor. It also has a factory method that will return clients
 174             for StrikeIron services:
 175
 176             <programlisting language="php"><![CDATA[
 177 $strikeIron = new Zend_Service_StrikeIron(array('username' => 'your-username',
 178                                                 'password' => 'your-password'));
 179
 180 $taxBasic = $strikeIron->getService(array('class' => 'SalesUseTaxBasic'));
 181 ]]></programlisting>
 182         </para>
 183
 184         <para>
 185             The <methodname>getService()</methodname> method will return a client for any
 186             StrikeIron service by the name of its <acronym>PHP</acronym> wrapper class. In this
 187             case, the name <code>SalesUseTaxBasic</code> refers to the wrapper class
 188             <classname>Zend_Service_StrikeIron_SalesUseTaxBasic</classname>. Wrappers are
 189             included for three services and described in
 190             <link linkend="zend.service.strikeiron.bundled-services">Bundled Services</link>.
 191         </para>
 192
 193         <para>
 194             The <methodname>getService()</methodname> method can also return a client for
 195             a StrikeIron service that does not yet have a <acronym>PHP</acronym> wrapper. This is
 196             explained in
 197             <link linkend="zend.service.strikeiron.advanced-uses.services-by-wsdl">Using Services by
 198                 WSDL</link>.
 199         </para>
 200     </sect2>
 201
 202     <sect2 id="zend.service.strikeiron.making-first-query">
 203         <title>Making Your First Query</title>
 204
 205         <para>
 206             Once you have used the <methodname>getService()</methodname> method to get a client
 207             for a particular StrikeIron service, you can utilize that client
 208             by calling methods on it just like any other PHP object.
 209
 210             <programlisting language="php"><![CDATA[
 211 $strikeIron = new Zend_Service_StrikeIron(array('username' => 'your-username',
 212                                                 'password' => 'your-password'));
 213
 214 // Get a client for the Sales & Use Tax Basic service
 215 $taxBasic = $strikeIron->getService(array('class' => 'SalesUseTaxBasic'));
 216
 217 // Query tax rate for Ontario, Canada
 218 $rateInfo = $taxBasic->getTaxRateCanada(array('province' => 'ontario'));
 219 echo $rateInfo->province;
 220 echo $rateInfo->abbreviation;
 221 echo $rateInfo->GST;
 222 ]]></programlisting>
 223
 224             In the example above, the <methodname>getService()</methodname> method is used
 225             to return a client to the <link
 226                 linkend="zend.service.strikeiron.bundled-services.sales-use-tax-basic">Sales &amp;
 227                 Use Tax Basic</link> service. The client object is stored in
 228             <varname>$taxBasic</varname>.
 229         </para>
 230
 231         <para>
 232             The <methodname>getTaxRateCanada()</methodname> method is then called on the
 233             service. An associative array is used to supply keyword parameters to
 234             the method. This is the way that all StrikeIron methods are called.
 235         </para>
 236
 237         <para>
 238             The result from <methodname>getTaxRateCanada()</methodname> is stored in
 239             <varname>$rateInfo</varname> and has properties like <code>province</code>
 240             and <constant>GST</constant>.
 241         </para>
 242
 243         <para>
 244             Many of the StrikeIron services are as simple to use as the example above. See
 245             <link linkend="zend.service.strikeiron.bundled-services">Bundled Services</link>
 246             for detailed information on three StrikeIron services.
 247         </para>
 248     </sect2>
 249
 250     <sect2 id="zend.service.strikeiron.examining-results">
 251         <title>Examining Results</title>
 252
 253         <para>
 254             When learning or debugging the StrikeIron services, it's often useful to dump the
 255             result returned from a method call. The result will always be an object that is an
 256             instance of <classname>Zend_Service_StrikeIron_Decorator</classname>. This is a
 257             small <ulink url="http://en.wikipedia.org/wiki/Decorator_pattern">decorator</ulink>
 258             object that wraps the results from the method call.
 259         </para>
 260
 261         <para>
 262             The simplest way to examine a result from the service is to use the built-in
 263             PHP functions like <ulink url="http://www.php.net/print_r">print_r()</ulink>:
 264
 265             <programlisting language="php"><![CDATA[
 266 <?php
 267 $strikeIron = new Zend_Service_StrikeIron(array('username' => 'your-username',
 268                                                 'password' => 'your-password'));
 269
 270 $taxBasic = $strikeIron->getService(array('class' => 'SalesUseTaxBasic'));
 271
 272 $rateInfo = $taxBasic->getTaxRateCanada(array('province' => 'ontario'));
 273 print_r($rateInfo);
 274 ?>
 275
 276 Zend_Service_StrikeIron_Decorator Object
 277 (
 278     [_name:protected] => GetTaxRateCanadaResult
 279     [_object:protected] => stdClass Object
 280         (
 281             [abbreviation] => ON
 282             [province] => ONTARIO
 283             [GST] => 0.06
 284             [PST] => 0.08
 285             [total] => 0.14
 286             [HST] => Y
 287         )
 288 )
 289 ]]></programlisting>
 290         </para>
 291
 292         <para>
 293             In the output above, we see that the decorator (<varname>$rateInfo</varname>) wraps an
 294             object named <code>GetTaxRateCanadaResult</code>, the result of the call to
 295             <methodname>getTaxRateCanada()</methodname>.
 296         </para>
 297
 298         <para>
 299             This means that <varname>$rateInfo</varname> has public properties like
 300             <code>abbreviation</code>, <code>province</code>, and <constant>GST</constant>. These
 301             are accessed like <code>$rateInfo->province</code>.
 302         </para>
 303
 304         <tip>
 305             <para>
 306                 StrikeIron result properties sometimes start with an uppercase letter such as
 307                 <code>Foo</code> or <code>Bar</code> where most <acronym>PHP</acronym> object
 308                 properties normally start with a lowercase letter as in <code>foo</code> or
 309                 <code>bar</code>. The decorator will automatically do this inflection so you
 310                 may read a property <code>Foo</code> as <code>foo</code>.
 311             </para>
 312         </tip>
 313
 314         <para>
 315             If you ever need to get the original object or its name out of the decorator, use the
 316             respective methods <methodname>getDecoratedObject()</methodname> and
 317             <methodname>getDecoratedObjectName()</methodname>.
 318         </para>
 319     </sect2>
 320
 321     <sect2 id="zend.service.strikeiron.handling-errors">
 322         <title>Handling Errors</title>
 323
 324         <para>
 325             The previous examples are naive, i.e. no error handling was shown.
 326             It's possible that StrikeIron will return a fault during a method
 327             call. Events like bad account credentials or an expired subscription
 328             can cause StrikeIron to raise a fault.
 329         </para>
 330
 331         <para>
 332             An exception will be thrown when such a fault occurs. You should
 333             anticipate and catch these exceptions when making method calls to the
 334             service:
 335
 336             <programlisting language="php"><![CDATA[
 337 $strikeIron = new Zend_Service_StrikeIron(array('username' => 'your-username',
 338                                                 'password' => 'your-password'));
 339
 340 $taxBasic = $strikeIron->getService(array('class' => 'SalesUseTaxBasic'));
 341
 342 try {
 343
 344   $taxBasic->getTaxRateCanada(array('province' => 'ontario'));
 345
 346 } catch (Zend_Service_StrikeIron_Exception $e) {
 347
 348   // error handling for events like connection
 349   // problems or subscription errors
 350
 351 }
 352 ]]></programlisting>
 353
 354             The exceptions thrown will always be
 355             <classname>Zend_Service_StrikeIron_Exception</classname>.
 356         </para>
 357
 358         <para>
 359             It's important to understand the difference between exceptions and
 360             normal failed method calls. Exceptions occur for
 361             <emphasis>exceptional</emphasis> conditions, such as
 362             the network going down or your subscription expiring.
 363             Failed method calls that are a common occurrence,
 364             such as <methodname>getTaxRateCanada()</methodname> not finding the
 365             <code>province</code> you supplied, will not result an in exception.
 366         </para>
 367
 368         <note>
 369             <para>
 370                 Every time you make a method call to a StrikeIron service, you
 371                 should check the response object for validity and also be
 372                 prepared to catch an exception.
 373             </para>
 374         </note>
 375
 376         <para><!-- included for whitespace --></para>
 377     </sect2>
 378
 379     <sect2 id="zend.service.strikeiron.checking-subscription">
 380         <title>Checking Your Subscription</title>
 381
 382         <para>
 383             StrikeIron provides many different services. Some of these are
 384             free, some are available on a trial basis, and some are pay subscription only.
 385             When using StrikeIron, it's important to be aware of your subscription
 386             status for the services you are using and check it regularly.
 387         </para>
 388
 389         <para>
 390             Each StrikeIron client returned by the <code>getService</code> method
 391             has the ability to check the subscription status for that service using
 392             the <methodname>getSubscriptionInfo()</methodname> method of the client:
 393
 394             <programlisting language="php"><![CDATA[
 395 // Get a client for the Sales & Use Tax Basic service
 396 $strikeIron = new Zend_Service_StrikeIron(array('username' => 'your-username',
 397                                                 'password' => 'your-password'));
 398
 399 $taxBasic = $strikeIron->getService(array('class => 'SalesUseTaxBasic'));
 400
 401 // Check remaining hits for the Sales & Use Tax Basic service
 402 $subscription = $taxBasic->getSubscriptionInfo();
 403 echo $subscription->remainingHits;
 404 ]]></programlisting>
 405         </para>
 406
 407         <para>
 408             The <methodname>getSubscriptionInfo()</methodname> method will return an object
 409             that typically has a <code>remainingHits</code> property. It's
 410             important to check the status on each service that you are using. If
 411             a method call is made to StrikeIron after the remaining hits have been
 412             used up, an exception will occur.
 413         </para>
 414
 415         <para>
 416             Checking your subscription to a service does not use any remaining
 417             hits to the service. Each time any method call to the service is made,
 418             the number of hits remaining will be cached and this cached value will
 419             be returned by <methodname>getSubscriptionInfo()</methodname> without connecting
 420             to the service again. To force <methodname>getSubscriptionInfo()</methodname>
 421             to override its cache and query the subscription information again, use
 422             <methodname>getSubscriptionInfo(true)</methodname>.
 423         </para>
 424     </sect2>
 425 </sect1>