Difference between revisions of "X-Cart:Setting up Your API Access"

From X-Cart 4 Classic
Jump to: navigation, search
m
m (Reverted edits by Dohtur (Talk) to last revision by Ivka)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
''This step is required for Website Payments Pro and Express Checkout used as an additional payment option.''
 
''This step is required for Website Payments Pro and Express Checkout used as an additional payment option.''
  
−
To enable your X-Cart based store to communicate with PayPal servers, you need to obtain your API credentials from PayPal. API credentials identify you when you make API calls. PayPal's API credentials consist of an API username and password (these are not the same as the username and password you use to log in to paypal.com), and a third piece of information - either an API signature or an API SSL client-side certificate.
+
To enable X-Cart to work with your PayPal Business account, you need to obtain your API credentials from PayPal. API credentials identify you when you make API calls. API credentials for X-Cart consist of an API username, an API password, and a third credential that can be either an API signature or an API SSL client-side certificate.
  
−
More information about PayPal's API credentials and instructions for requesting such credentials for your account are available here: [http://qwyx.co/apihowto http://qwyx.co/apihowto].
+
To obtain your API credentials:
  
−
{{Note1|Important: Please note that to be able to use an API SSL client-side certificate as your credential, you need to be able to install the certificate on the web server in the directory <u><xcart_dir>/payment/certs/</u>, where <u><xcart_dir></u> is the directory where your X-Cart is installed.}}
+
# Log in to your PayPal account and click the '<u>Profile</u>' subtab.
 +
# Click '<u>API Access</u>' in the '<u>Account Information</u>' column.
 +
# Click '<u>Request API Credential</u>'.
 +
# Select the type of credential: API signature or API SSL client-side certificate. (API signature is a 128-bit signature that is included in your API calls to identify you as an authorized caller. API SSL client-side certificate is an SSL certificate that is installed on your web server).<br/>
 +
{{Note1|Important: Please note that to be able to use an API SSL client-side certificate as your credential, you need to be able to install the certificate on the web server in the directory <tt><xcart_dir>/payment/certs/</tt>, where <tt><xcart_dir></tt> is the name of the directory in which X-Cart is installed.}}
 +
 
 +
:5. Click '<u>Submit</u>'.
 +
 
 +
If you select API Signature, your credentials will simply be provided to you on the next page. From now on, they will be stored in your profile ('<u>Profile</u>' subtab->'<u>API Access</u>' link->'<u>View or Remove Credentials</u>').
 +
 
 +
If you select API SSL client-side certificate, your API Username and API Password will be provided to you on the next page the same way as if you had requested an API Signature, while the API Certificate will need to be downloaded. To download your API certificate, click the '<u>Download Certificate</u>' button on the '<u>Download or Remove API Certificate</u>' page. You will be prompted to download a file called <u>cert_key_pem.txt</u>. This file is your API Certificate. You will need to put this file in <tt><xcart_dir>/payment/certs/</tt>.
  
 
[[Category:X-Cart user manual]]
 
[[Category:X-Cart user manual]]

Latest revision as of 15:29, 10 December 2012

This step is required for Website Payments Pro and Express Checkout used as an additional payment option.

To enable X-Cart to work with your PayPal Business account, you need to obtain your API credentials from PayPal. API credentials identify you when you make API calls. API credentials for X-Cart consist of an API username, an API password, and a third credential that can be either an API signature or an API SSL client-side certificate.

To obtain your API credentials:

  1. Log in to your PayPal account and click the 'Profile' subtab.
  2. Click 'API Access' in the 'Account Information' column.
  3. Click 'Request API Credential'.
  4. Select the type of credential: API signature or API SSL client-side certificate. (API signature is a 128-bit signature that is included in your API calls to identify you as an authorized caller. API SSL client-side certificate is an SSL certificate that is installed on your web server).
Important: Please note that to be able to use an API SSL client-side certificate as your credential, you need to be able to install the certificate on the web server in the directory <xcart_dir>/payment/certs/, where <xcart_dir> is the name of the directory in which X-Cart is installed.
5. Click 'Submit'.

If you select API Signature, your credentials will simply be provided to you on the next page. From now on, they will be stored in your profile ('Profile' subtab->'API Access' link->'View or Remove Credentials').

If you select API SSL client-side certificate, your API Username and API Password will be provided to you on the next page the same way as if you had requested an API Signature, while the API Certificate will need to be downloaded. To download your API certificate, click the 'Download Certificate' button on the 'Download or Remove API Certificate' page. You will be prompted to download a file called cert_key_pem.txt. This file is your API Certificate. You will need to put this file in <xcart_dir>/payment/certs/.

Retrieved from "https://help.x-cart.com/index.php?title=X-Cart:Setting_up_Your_API_Access&oldid=9635"