eBay::API::BaseApi 0.22

eBay::API::BaseApi contains logging, exception handling and authentication frameworks for eBay::API objects.

This top-level module encapsulates all the functionality for the eBay API. This library is really a parent class wrapper to the sub-classes of eBay::API--mainly sessions and api call objects.

The main purpose of this framework is to provide event logging, exception handling, and management eBay API certification information.

Users of eBay::API can use this facility to debug requests to the eBay API and responses from the eBay API. Unless the user overrides the default behavior, all logging will go to stderr.

Usage:

eBay::API::XML::Session->new({args})
eBay::API::XML::Session::new("eBay::API::XML::Request", {args} )

Arguments:

The name of this class/package.

A hash reference containing the following possible arguments:
site_id => Scalar representing the eBay site id of the XML API calls. Setting the site id at the session level will provide a default site id for all API calls bundled into a session. The site id for individual calls may still be overridden when the respective request objects are instantiated.

If this value is not provided, it will attempt to use the value in the environment variable $EBAY_API_SITE_ID;
dev_id => Scalar representing the Developer ID provided to the user by eBay. The developer ID is unique to each licensed developer (or company). By default this will be taken from the environment variable $EBAY_API_DEV_ID, but it can be overridden here or via the setDevID() class method.
app_id => Scalar representing the Application ID provided to the user by eBay. The application ID is unique to each application created by the developer. By default this will be taken from the environment variable $EBAY_API_APP_ID, but it can be overridden here or via the setAppID() class method.
cert_id => Scalar representing the Certification ID provided to the user by eBay. The certificate ID is unique to each application created by the developer. By default this will be taken from the environment variable $EBAY_API_CERT_ID, but it can be overridden here or via the setCertID() class method.
user_name => Scalar representing the application level user name for this session. This may be overriden for each bundled call in the session.

user_password => Scalar reprsenting the application level user password for this session. This may be overriden for each bundled call in the session.

user_auth_token => Scalar representing the auth token for the application level user.

api_ver => Scalar representing the eBay webservices API version the user wishes to utilize. If this is not set here, it is taken from the environment variable $EBAY_API_VERSION, which can be overridden via the class method setVersion().
proxy => Scalar representing the eBay transport URL needed to send the request to. If this is not set here, it must be set via the setProxy() class method, prior to object instantiation.

# Deprecated #=item * # #debug => Boolean. TRUE means we'll want debugging for the #request/response. FALSE means no debugging.

# Deprecated #=item * # #err_lang => Value for the error language you would like returned to #you for any XML/webservice errors encountered. By design, if this #value is not provided, eBay will return en-US as the default error #language value. This can be set at the class level via the #setErrLang() method, and retrieved from the getErrLang() method. It #can also be set for a particular instance with the instance #getter/setter method errLang().

compatibility_level => This value is defined as a default in each release of the api. But if you need to override the default value, you can do this either when you instatiate your session object, or by using the setter method setCompatibilityLevel().

sequential => Boolean value to indicate if the requests should be issued sequentially if true, and in parallel if false (default). This may also be set with the setter method setExecutionSequential().

timeout => Scalar numerical value indicating the number of seconds to wait on an http request before timing out. Setting this to 0 will cause the requests to block. Otherwise the default is that of LWP::UserAgent. This may also be set with the instance setter method setTimeout();

Returns:

success Object reference to the eBay::API::XML::Session class.
failure undefined

Product's homepage

Requirements:

· Perl