PAAPI Component
Properties Methods Events Configuration Settings Errors
The PAAPI Component provides an easy interface to Amazon Associates Web Service (formerly known as "ECS").
Syntax
TibaPAAPI
Remarks
The PAAPI Component allows you to access Amazon's product data and e-commerce functionality, allowing developers, web site creators and any online services to easily use the data and functionality that Amazon exposes to power its own e-commerce business. The PAAPI Component makes it very easy for developers to create rich, highly effective applications and web sites. Please refer to Amazon Associates documentation for further details.
You will first need to sign up for the PAAPI service and obtain the AccessKey from Amazon. Then you can start polling Amazon's PAAPI servers for data and making online transactions.
You may need to refer to Amazon's website for a full list of available functionality.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| AccessKey | The Access Key Id for the Amazon Web Services account. |
| AssociateTag | The Associate Tag for the Amazon Web Services account. |
| AttrBase | The relative path to the attributes wanted per item. |
| FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallType | This property determines the type of firewall to connect through. |
| FirewallHost | This property contains the name or IP address of firewall (optional). |
| FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
| FirewallPort | This property contains the TCP port for the firewall Host . |
| FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
| ItemASIN | Returns the ASIN of the item at ItemIndex . |
| ItemAttrs | The total number of attributes for the current item. |
| ItemCount | The total number of items in the response. |
| ItemIndex | The index of the current Item in the response. |
| ItemType | Populated when the Item Type is determined by the component. |
| ItemXML | Returns the full item XML subtree for the item at ItemIndex . |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| Operation | The operation which will be executed by the PAAPI component. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ParamCount | The number of records in the Param arrays. |
| ParamName | The Name of the AWS Parameter. |
| ParamValue | The Value of the AWS Parameter. |
| ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
| ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
| ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
| ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
| ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| ProxySSL | This property determines when to use SSL for the connection to the proxy. |
| ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
| SecretKey | The Secret Access Key for the Amazon Web Services account. |
| ServiceURL | This is the locale to which you want to send the request. |
| SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertStore | The name of the certificate store for the client certificate. |
| SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
| SSLCertStoreType | The type of certificate store for this certificate. |
| SSLCertSubject | The subject of the certificate used for client authentication. |
| SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
| StatusLine | The first line of the last server response. |
| Timeout | A timeout for the component. |
| XAttrCount | The number of records in the XAttr arrays. |
| XAttrName | The Name provides the local name (without prefix) of the attribute. |
| XAttrNamespace | Attribute namespace. |
| XAttrPrefix | Attribute prefix (if any). |
| XAttrValue | Attribute value. |
| XChildrenCount | The number of records in the XChild arrays. |
| XChildName | The Name property provides the local name (without prefix) of the element. |
| XChildNamespace | Namespace of the element. |
| XChildPrefix | Prefix of the element (if any). |
| XChildXText | The inner text of the element. |
| XElement | The name of the current element. |
| XNamespace | The namespace of the current element. |
| XParent | The parent of the current element. |
| XPath | Provides a way to point to a specific element in the document. |
| XPrefix | The prefix of the current element. |
| XSubTree | A snapshot of the current element in the document. |
| XText | The text of the current element. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| AddParam | Adds a parameter to the query string. |
| Config | Sets or retrieves a configuration setting . |
| DoEvents | Processes events from the internal message queue. |
| GetItemAttr | Returns the specified attribute from the current item at ItemIndex . |
| GetXValue | Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest . |
| GoToItem | Tells the parser to go to the indicated ItemIndex . |
| Interrupt | Interrupt the current method. |
| Reset | Resets request-related properties. |
| ResetHeaders | Resets all HTTP headers, cookies, and localfile. |
| SendCustomRequest | Allows the sending of a custom request to an Amazon web service. |
| SendRequest | Send the request to Amazon. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| Connected | Fired immediately after a connection completes (or fails). |
| ConnectionStatus | Fired to indicate changes in connection state. |
| Disconnected | Fired when a connection is closed. |
| Error | Information about errors during data delivery. |
| Header | Fired every time a header line comes in. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
| Status | Fired when the HTTP status line is received from the server. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| CacheContent | If true, the original XML is saved in a buffer. |
| ThrowExceptionOnError | If true, an exception is thrown when an error is found in the response. |
| APIVersion | Amazon's API version. |
| HTTPMethod | Specifies the HTTP method to use when sending a custom request. |
| SignCustomRequest | Tells the component to sign the outgoing request. |
| TransferredData | Returns the entire XML response received from Amazon. |
| URL | If set, the default URL will be overridden by this value. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowIdenticalRedirectURL | Allow redirects to the same URL. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTPVersion | The version of HTTP used by the component. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |