{\rtf1\ansi\ansicpg1252\cocoartf949\cocoasubrtf430 {\fonttbl\f0\fswiss\fcharset0 Helvetica;} {\colortbl;\red255\green255\blue255;} \margl1440\margr1440\vieww9000\viewh8400\viewkind0 \pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\ql\qnatural\pardirnatural \f0\fs24 \cf0 PHP Wrapper Class for sendcube API 1.0\ ================================================================================\ \ CONTENTS\ \ 1. Introduction\ 2. Requirements\ 3. Getting Started\ 4. Using the Examples\ 5. License\ \ ================================================================================\ \ 1. INTRODUCTION\ \ This wrapper class is provided to help you integrate with our API using the \ PHP5 development platform. It abstracts the internals of the API so that you \ not have to directly manipulate the connection, transfer of data and parsing of \ results and errors. This gives you the convenience of accessing our API using \ PHP structures that are familiar to you.\ \ \ 2. REQUIREMENTS\ \ This PHP wrapper class requires PHP5.\ \ \ 3. GETTING STARTED\ \ To use the wrapper class in your own programs, simply copy the ScAPI.class.php \ file into your directory structure, and include it in your own scripts. You can\ then construct a ScAPI object and set your API key, as shown in this example:\ \ $api = new ScAPI();\ $api->setAPIKey('abcdefghijklmnopqrstuvwxyz');\ \ You can also use the following alternate syntax to construct and set your API \ key in one step, passing in your own API key as a parameter to the constructor:\ \ $api = new ScAPI('abcdefghijklmnopqrstuvwxyz');\ \ \ 4. USING THE EXAMPLES\ \ Examples are included in this package to illustrate how you can use this \ wrapper class to carry out specific tasks. These are only meant for working \ examples to highlight the procedures to call and the results to expect for each \ task, and should not be taken as complete code that you can directly implement \ in your programs. Instead, you should be familiar with the PHP programming \ environment and be able to draw from these provided examples for your own \ specific uses.\ \ Before you can run these examples, you need to edit the config.inc file in the \ examples folder to insert your API key.\ \ These examples are intended to be run from your terminal window or command \ prompt. Instructions on the usage of each example script is provided within the\ individual scripts. \ \ \ 5. LICENSE\ \ Copyright (c) 2008 sendcube, released under the MIT license\ \ Permission is hereby granted, free of charge, to any person obtaining a copy\ of this software and associated documentation files (the "Software"), to deal\ in the Software without restriction, including without limitation the rights\ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ copies of the Software, and to permit persons to whom the Software is\ furnished to do so, subject to the following conditions:\ \ The above copyright notice and this permission notice shall be included in\ all copies or substantial portions of the Software.\ \ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\ THE SOFTWARE.\ }