User Tools
admin_dashboard:system_admin:system_settings:create_sandboxpaypaladaptiveapi
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
admin_dashboard:system_admin:system_settings:create_sandboxpaypaladaptiveapi [2015/07/29 09:54] mooeditor [Encrypting your certificate] |
admin_dashboard:system_admin:system_settings:create_sandboxpaypaladaptiveapi [2015/07/29 10:03] mooeditor [Renewing an API certificate] |
||
|---|---|---|---|
| Line 27: | Line 27: | ||
| ^Credential Set ^Credential Names | | ^Credential Set ^Credential Names | | ||
| - | |//Signature// set | | + | | \\ \\ \\ Signature Set \\ | \\ API Username \\ \\ API Password \\ \\ Signature \\ | |
| - | * API Username | + | | \\ \\ \\ Certificate Set \\ | \\ API Username \\ \\ API Password \\ \\ Certificate \\ | |
| - | * API Password | + | |
| - | * Signature | + | |
| - | |//Certificate// set | | + | |
| - | * API Username | + | |
| - | * API Password | + | |
| - | * Certificate | + | |
| While you can use either set to authenticate requests to the Classic API platform, for security reasons, PayPal recommends you use Certificate credentials. For more on Certificate credentials, see [[https://developer.paypal.com/docs/classic/api/apiCredentials/#certs|Managing Certificate Credentials]]. | While you can use either set to authenticate requests to the Classic API platform, for security reasons, PayPal recommends you use Certificate credentials. For more on Certificate credentials, see [[https://developer.paypal.com/docs/classic/api/apiCredentials/#certs|Managing Certificate Credentials]]. | ||
| **Note:** You authenticate calls to the //Adaptive// APIs (Adaptive Accounts, Adaptive Payments, the Invoicing service, and the Permissions service) using these same credentials. However, all Adaptive platform APIs require that you also supply an ''appID'' in addition to your Signature or Certificate credential values. | **Note:** You authenticate calls to the //Adaptive// APIs (Adaptive Accounts, Adaptive Payments, the Invoicing service, and the Permissions service) using these same credentials. However, all Adaptive platform APIs require that you also supply an ''appID'' in addition to your Signature or Certificate credential values. | ||
| + | |||
| + | \\ | ||
| ===== Creating Classic API credentials ===== | ===== Creating Classic API credentials ===== | ||
| Line 57: | Line 53: | ||
| ==== 3. Generate the Certificate set ==== | ==== 3. Generate the Certificate set ==== | ||
| - | - | + | 1.Click **Request API Credentials** on the **API Access** page: |
| - | + | ||
| - | Click **Request API Credentials** on the **API Access** page: | + | |
| {{https://www.paypalobjects.com/webstatic/en_US/developer/docs/api/classicApiCerts/requestApiCreds.png?nolink&}} | {{https://www.paypalobjects.com/webstatic/en_US/developer/docs/api/classicApiCerts/requestApiCreds.png?nolink&}} | ||
| - | **Note:** If you’ve already generated a set of API credentials, you’ll have to delete your existing set before you can generate a new set of credentials. | + | **Note:** If you’ve already generated a set of API credentials, you’ll have to delete your existing set before you can generate a new set of credentials. |
| - | - | + | 2.Select **Request API signature** and click **Agree and Submit** to generate a set of Signature credentials. |
| - | + | ||
| - | Select **Request API signature** and click **Agree and Submit** to generate a set of Signature credentials. | + | |
| Here’s an example showing a set of Signature credentials (for [[https://developer.paypal.com/docs/classic/api/apiCredentials/#certs|Certificate]] credentials, see the section below): | Here’s an example showing a set of Signature credentials (for [[https://developer.paypal.com/docs/classic/api/apiCredentials/#certs|Certificate]] credentials, see the section below): | ||
| Line 77: | Line 69: | ||
| Certificate credentials are much like the Signature credentials described above, however there are differences in the way that you generate and use the credentials. | Certificate credentials are much like the Signature credentials described above, however there are differences in the way that you generate and use the credentials. | ||
| - | **Note:** If your API Certificate is expiring, skip ahead to [[https://developer.paypal.com/docs/classic/api/apiCredentials/#renew|Renewing an API Certificate]]. | + | **Note:** If your API Certificate is expiring, skip ahead to [[https://developer.paypal.com/docs/classic/api/apiCredentials/#renew|Renewing an API Certificate]]. |
| You create an API Certificate much like create Signature credentials. The steps below describe the differences: | You create an API Certificate much like create Signature credentials. The steps below describe the differences: | ||
| - | - | + | 1.On the **Request API Credentials** page, select the **Request API Certificate** radio button, then click the **Agree and Submit** button (see [[https://developer.paypal.com/docs/classic/api/apiCredentials/#step3|Step 3]] above for more details).{{https://www.paypalobjects.com/webstatic/en_US/developer/docs/api/classicApiCerts/createCert.png?nolink&}} |
| - | On the **Request API Credentials** page, select the **Request API Certificate** radio button, then click the **Agree and Submit** button (see [[https://developer.paypal.com/docs/classic/api/apiCredentials/#step3|Step 3]] above for more details). | + | The **Download or Remove API Certificate** page displays. |
| - | {{https://www.paypalobjects.com/webstatic/en_US/developer/docs/api/classicApiCerts/createCert.png?nolink&}} | + | 2.Click **Download Certificate**.\\ |
| + | The certificate is downloaded to a file named ''cert_key_perm.txt''. Be sure to save the file to a secure location. | ||
| - | The **Download or Remove API Certificate** page displays. | + | PayPal formats the API Certificate file in PEM format. The file contains both your //public certificate// and the associated //private key//. Although the PEM certificate is not human readable, the file is not [[https://developer.paypal.com/docs/classic/api/apiCredentials/#encrypt|encrypted]]. |
| - | + | ||
| - | - | + | |
| - | + | ||
| - | Click **Download Certificate**. \\ The certificate is downloaded to a file named ''cert_key_perm.txt''. Be sure to save the file to a secure location. | + | |
| - | + | ||
| - | PayPal formats the API Certificate file in PEM format. The file contains both your //public certificate// and the associated //private key//. Although the PEM certificate is not human readable, the file is not [[https://developer.paypal.com/docs/classic/api/apiCredentials/#encrypt|encrypted]]. | + | |
| ==== Renewing an API certificate ==== | ==== Renewing an API certificate ==== | ||
| Line 101: | Line 88: | ||
| The certificate renewal process generates a new certificate that you can install to replace any expiring certificate. | The certificate renewal process generates a new certificate that you can install to replace any expiring certificate. | ||
| - | - | + | 1.Log in to your PayPal account, and navigate to the **Manage API Certificate** page.\\ |
| + | To do so, select **My Account > Profile > My Selling Tools**, click the **Update (API Access)** link, then click **View API Certificate**. | ||
| - | Log in to your PayPal account, and navigate to the **Manage API Certificate** page. \\ To do so, select **My Account > Profile > My Selling Tools**, click the **Update (API Access)** link, then click **View API Certificate**. | + | 2.On the **Manage API Certificate** page, check the status of your API Certificate, whether it is **Active** or **About to expire**. |
| - | + | ||
| - | - | + | |
| - | + | ||
| - | On the **Manage API Certificate** page, check the status of your API Certificate, whether it is **Active** or **About to expire**. | + | |
| {{https://www.paypalobjects.com/webstatic/en_US/developer/docs/api/classicApiCerts/certAlert.png?nolink&}} | {{https://www.paypalobjects.com/webstatic/en_US/developer/docs/api/classicApiCerts/certAlert.png?nolink&}} | ||
| - | - | + | 3.If the status of your certificate is **About to expire**, click the **Renew certificate** button. |
| - | If the status of your certificate is **About to expire**, click the **Renew certificate** button. | + | An additional certificate is generated and given an **Active** status. Both the new and old certificates appear in the **Manage API Certificate** page. |
| - | + | ||
| - | An additional certificate is generated and given an **Active** status. Both the new and old certificates appear in the **Manage API Certificate** page. | + | |
| {{https://www.paypalobjects.com/webstatic/en_US/developer/docs/api/classicApiCerts/certRenewed.png?nolink&}} | {{https://www.paypalobjects.com/webstatic/en_US/developer/docs/api/classicApiCerts/certRenewed.png?nolink&}} | ||
| - | - | + | 4.On the certificate marked as //Active//, click **Download certificate** and follow the steps in [[https://developer.paypal.com/docs/classic/api/apiCredentials/#certs|Managing Certificate Credentials]] for details on downloading and using the updated certificate. |
| - | + | ||
| - | On the certificate marked as //Active//, click **Download certificate** and follow the steps in [[https://developer.paypal.com/docs/classic/api/apiCredentials/#certs|Managing Certificate Credentials]] for details on downloading and using the updated certificate. | + | |
| - | After you’ve imported the new API Certificate, test your integration to ensure it works with the new certificate. Distribute your new API Certificate to all affected partners. Once the old certificate expires, remove it by clicking the **Remove certificate** button associated with the certificate. | + | After you’ve imported the new API Certificate, test your integration to ensure it works with the new certificate. Distribute your new API Certificate to all affected partners. Once the old certificate expires, remove it by clicking the **Remove certificate** button associated with the certificate. |
| ==== Encrypting your certificate ==== | ==== Encrypting your certificate ==== | ||
admin_dashboard/system_admin/system_settings/create_sandboxpaypaladaptiveapi.txt · Last modified: 2015/08/24 01:12 (external edit)
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 3.0 Unported
