| eBay-API-Simple documentation | view source | Contained in the eBay-API-Simple distribution. |
eBay::API::SimpleBase - Flexible SDK supporting all eBay web services
This is the base class for the eBay::API::Simple::* libraries that provide support for all of eBay's web services. This base class does nothing by itself and must be subclassed to provide the complete web service support.
http://code.google.com/p/ebay-api-simple
see subclass for more docs.
This method should be supplied by the subclass. This one is only here to provide an example. See actual subclass for docs.
Calling this method will make build and execute the api request.
call verb, i.e. FindItems
hashref of call_data that will be turned into xml.
Accessor for the LWP::UserAgent request agent
Accessor for the HTTP::Request request object
Accessor for the complete request body from the HTTP::Request object
Accessor for the HTTP response body content
Accessor for the HTTP::Request response object
Accessor for the LibXML response DOM
Accessor for the hashified response content
Not implemented yet.
Helper for LibXML that retrieves node content
This is the name of the xml element
optionally a DOM object can be passed in. If no DOM object is passed then the main response DOM object is used.
Accessor to the hashref of errors
Returns true if the call contains errors
Returns a string of API errors if there are any.
Accessor to a hashref of api config data that will be used to execute the api call.
siteid,domain,uri,etc.
This method is used to merge config into the config_api hash
This method is used for debugging
This method lets you append errors to the errors stack
This method performs the http request and should be used by each subclass.
Upon execute() we need to undef any data from a previous call. This method will clear all call data and is usually done before each execute
Constructs a URL based on the supplied args
The request body should be provided by the subclass
The request headers should be provided by the subclass
The request request agent should be used by all subclasses
The request object should be provided by the subclass
This method will search for the ebay.yaml file and load configuration defaults for each service endpoint
YAML files can be placed at the below locations. The first file found will be loaded.
./ebay.yaml, ~/ebay.yaml, /etc/ebay.yaml
Sample YAML:
# Trading - External
api.ebay.com:
appid: <your appid>
certid: <your certid>
devid: <your devid>
token: <token>
# Shopping
open.api.ebay.com:
appid: <your appid>
certid: <your certid>
devid: <your devid>
version: 671
# Finding/Merchandising
svcs.ebay.com:
appid: <your appid>
version: 1.0.0
Tim Keefer <tim@timkeefer.com>
Andrew Dittes <adittes@gmail.com>
| eBay-API-Simple documentation | view source | Contained in the eBay-API-Simple distribution. |