gunghogeoduck/osem-fcy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updating readme, install, payments, contributing files

Browse source
This commit is contained in:
Stella Rouzi 2017-03-13 14:29:52 +02:00
parent a826bb9d1e
commit e8699f4258
4 changed files with 109 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

50
PAYMENTS.md
View file

@ -1,33 +1,37 @@
# Integrate your Stripe account to accept your user's payments
Here you will find all the information that you need to setup your Stripe account into OSEM.
If you have any problems with installing don't hesitate to [contact us](https://github.com/openSUSE/osem#contact)
# Payments through Stripe
Here you will find all the information that you need to setup your Stripe account and integrate it into OSEM.
If you experience any problems, don't hesitate to [contact us](https://github.com/openSUSE/osem#contact)
## Configure Stripe into the application
To configure Stripe into your application all you need to do is add the private and publishable keys into the Rails environment.
You can register to Stripe [here](https://dashboard.stripe.com/register) and get your API keys for free.
**You need to set the API keys provided by Stripe into the application first to get the feature running.**
**To enable payments, you need to add the API keys, provided by Stripe, in OSEM.**
Add your Stripe API keys in `.env` file into these variables:
## Add Stripe credentials
To integrate Stripe into OSEM, all you need to do is add the *publishable* and *secret* keys into the Rails environment.
If you are using the application in development mode your config should look like this:
`STRIPE_PUBLISHABLE_KEY = 'pk_**test**_random123example456'`
`STRIPE_SECRET_KEY = 'sk_**test**_random123example456'`
The application in development mode can be used to test the whole test feature but is still not ready to be used by your users.
You need to use the live API keys to use the payment feature in production mode.
1. Register with Stripe [here](https://dashboard.stripe.com/register) and get your API keys for free
In production mode, it should look like:
`STRIPE_PUBLISHABLE_KEY = 'pk_**live**_random123example456'`
`STRIPE_SECRET_KEY = 'sk_**live**_random123example456'`
In this mode, you can start accepting payments from your users.
2. Add your Stripe API keys in the following variables of your `.env` file:
## Testing feature in development mode
You can test the payment feature in development mode with some test cards.
Check out the list of test cards [here](https://stripe.com/docs/testing#cards).
* For **development**
* `STRIPE_PUBLISHABLE_KEY = 'pk_**test**_random123example456'`
* `STRIPE_SECRET_KEY = 'sk_**test**_random123example456'`
In development mode, the Stripe integration is useful for feature testing purposes. However, if you wish to enable payments for users, you need to use the live API keys.
* For **production**
* `STRIPE_PUBLISHABLE_KEY = 'pk_**live**_random123example456'`
* `STRIPE_SECRET_KEY = 'sk_**live**_random123example456'`
3. You are ready to start accepting payments from users
## Feature tests in development mode
You can test the payment feature in development mode using test credit cards; check out the list [here](https://stripe.com/docs/testing#cards).
### PCI Self Assessment Questionnaire(SAQ)
> As long as you serve your payment pages over TLS, and use either Checkout or Stripe.js
> as the only way of handling card information, Stripe automatically creates a prefilled SAQ A questionnaire for you,
> and you won’t need to undergo a PCI audit. If card data is stored or transferred through your servers,
> As long as you serve your payment pages over TLS, and use either Checkout or Stripe.js
> as the only way of handling card information, Stripe automatically creates a prefilled SAQ A questionnaire for you,
> and you won’t need to undergo a PCI audit. If card data is stored or transferred through your servers,
> you are responsible for following PCI DSS guidelines for handling card data, and periodic audits by a PCI-certified auditor.
As we are using Stripe Checkout for accepting payments, Stripe will help you for filling SAQ for your application.