Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision 		Previous revision
customer_portal:integration:stripeapikeys [2023/01/12 04:16]
leslie created 		— (current)
Line 1: Line 1:
-====== Stripe API Keys ====== 
- 
-To allow Imagatec to integrate with Stripe, the following API keys need to be emailed through to Imagatec Helpdesk Support at help@imagatec.com.au 
- 
-  * Live Publishable key (ie. pk_live_...) 
-  * Live Secret key (ie. sk_live_...) 
- 
-The API keys above are required for Stripe to authenticate Imagatec's API requests, allowing successful Stripe integration. Without them, Stripe integration cannot be enabled. 
- 
- 
-==== Obtaining your Stripe API Keys ==== 
-1. Open the Stripe Development Dashboard in your web browser: 
-https://dashboard.stripe.com/login 
- 
- 
-2. Enter your Stripe Account email and password and click continue: 
- 
- 
-3. If two-step authentication has been enabled, enter the 6-digit verification code that is sent to your mobile phone and click continue: 
- 
- 
-4. Check the box for "Im not a robot" 
- 
- 
-5. Select the images that have been requested and click verify (eg. if asked for "mountains or hills" select all the images with mountains or hills in them): 
- 
- 
-Note: if you make a mistake, you'll be shown new images and asked to select images again. 
- 
- 
-6. The API Keys page will load by default 
- 
- 
-7. If the "Viewing test data" option is enabled, only the "test" keys will be displayed (ie. pk_test_...): 
- 
- 
-8. Clicking the "Viewing test data" toggle button will switch to live data and display the "live" keys (ie. pk_live_...): 
- 
- 
-9. Click the token text to the right of the "Publishable Key" name to copy the "Publishable Key" text to your clipboard: 
- 
- 
-10. Open a text editor on your computer (ie. Notepad) and "paste" the "Publishable Key" text on the first line: 
- 
- 
-11. Save the text file as: 
-YourCompanyName_Stripe_API_Keys.txt 
- 
- 
-13. Click "Reveal live key" to the right of the "Secret Key" name: 
- 
- 
-14. A pop-up will be displayed to warn you that the "Secret Key" will only be revealed once. Click "Reveal: 
- 
- 
-. Once the "Secret Key" is revealed you must copy and save it, as it cannot be revealed again if you accidentally close the window or forget the "Secret Key" in future. 
- 
- 
-15. Click the revealed text to copy the "Secret Key" text to your clipboard: 
- 
- 
-16. Open the previously saved text file (ie. YourCompanyName_Stripe_API_Keys.txt) and "paste" the "Secret Key" text on the second line: 
- 
- 
-17. Save the changes to the text file (ie. it should now have the "Publishable Key" text on the first line and the "Secret Key" text on the second line) 
- 
-18. Send an email to Imagatec Helpdesk (help@imagatec.com.au) with the Stripe API keys text file attached and include details of your company and what Stripe integrations your are wanting enabled. 
- 
- 
- 
-==== Roll API Key ==== 
-If you accidentally closed the window that revealed your "Secret Key" or you have lost the text file that contained your Stripe API keys, you will need to "Roll" the API key. 
- 
-**Warning:** 
-  * When you "Roll" the API key, the previous "Secret Key" will be disabled and can no longer be used and a new "Secret Key" will be generated. 
-  * Stripe will not authenticate any services using the previous "Secret Key" and any integrations using them will stop working until the new "Secret Key" that is generated and provided. 
- 
- 
-1. Click the dots to the right of the "Secret Key": 
- 
-2. Click "Roll key..." from the drop-down options: 
- 
-3. Set the "Expiration" to "now, enter your Stripe account password, and click "Roll API key" 
- 
-4. If two-step authentication has been enabled, enter the 6-digit verification code that is sent to your mobile phone and click continue: 
- 
-5. Click the revealed text to copy the "Secret Key" text to your clipboard: 
- 
-6. Open a text editor on your computer (ie. Notepad) and "paste" the "Secret Key" text on the second line: 
- 
-7. Save the text file as: 
-YourCompanyName_Stripe_API_Keys.txt 
- 
-8. Click "Done" to close the pop-up window showing the "Secret Key" 
- 
-9. Click the token text to the right of the "Publishable Key" name to copy the "Publishable Key" text to your clipboard: 
- 
-10. Open the previously saved text file (ie. YourCompanyName_Stripe_API_Keys.txt) and "paste" the "Publishable Key" text on the first line: 
- 
-11. Save the changes to the text file (ie. it should now have the "Publishable Key" text on the first line and the "Secret Key" text on the second line) 
- 
-12. As the "Secret Key" has been changed, you will need to send an email to Imagatec Helpdesk (help@imagatec.com.au) with the new Stripe API keys text file attached and include details of your company and what Stripe integrations were being used. 
-