install.md 1.97 KB
Newer Older
mattwire's avatar
mattwire committed
1 2 3 4
# Install / Configuration
Please do help improve this documentation by submitting a PR or contacting me.

## Configuration
5 6 7 8 9 10 11

### Stripe
Create an API key by logging in to your Stripe dashboard and selecting [API keys](https://dashboard.stripe.com/account/apikeys) from the left navigation.  You can use the standard key, or you can click "Create rrestricted key" to have a more limited key.  Example key restrictions are listed below.

### CiviCRM
All configuration is in the standard Payment Processors settings area in CiviCRM admin (**Administer menu » System Settings » Payment Processors**).
Add a payment processor and enter your "Publishable" & "Secret" keys given by stripe.com.  
mattwire's avatar
mattwire committed
12 13 14 15 16 17 18 19 20 21 22 23

## Installation
There are no special installation requirements.
The extension will show up in the extensions browser for automated installation.
Otherwise, download and install as you would for any other CiviCRM extension.

### How to update Stripe API version
More info on how to change:  https://stripe.com/docs/upgrades#how-can-i-upgrade-my-api

Go to _Account Settings_ -> _API Keys_ tab -> click _Upgrade available_ button.

Don't forget to update the webhook API version as well.
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48

### Stripe API Key restrictions
If you prefer, you can restrict the permissions available to the API key you create.  The below is an example that may have more permissions than is needed, but works with one-time payments, recurring payments, and the webhook check built into this extension.  If a permission isn't listed below, leave it as *None*.

**Core resources**  
Balance: *Read*  
Charges: *Write*  
Customers: *Write*  
Disputes: *Write*  
Events: *Read*  
Products: *Write*  
Sources: *Write*  
Tokens: *Read*  
**Billing resources**  
Plans: *Write*  
Subscriptions: *Write*  
**Connect resources**  
Application Fees: *Write*  
**Orders resources**  
SKUs: *Write*  
**Webhook resources**  
Webhook Endpoints: *Read* (required for the webhook system check)  
![Example Stripe API Permissions](images/example_api_perms.png)