btcpayserver/nopcommerce
btcpayserver/nopcommerce
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 3 Wiki Activity

Refactor readme

Browse Source 
replace img
This commit is contained in:
Pavlenex 2024-02-25 23:17:55 +05:00
parent 673f38be1c
commit d6e3466faf
2 changed files with 88 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

108
README.md
View File

@ -1,40 +1,108 @@
# BTCPay plugin for NopCommerce - accept Bitcoin payments
# BTCPay Server – Accept Bitcoin payments in nopCommerce
![BTCPay nopCommerce Banner](nopCommerceAcceptBitcoin.png)
## Plugin Overview
This plugin allows you to easily integrate Bitcoin payments into your NopCommerce website using BTCPay Server — a free, self-hosted and open-source payment gateway solution designed to revolutionize Bitcoin payments. Our seamless integration with NopCommerce ensures a hassle-free connection to your self-hosted BTCPay Server.
This plugin allows you to easily start accepting Bitcoin payments in your nopCommerce e-commerce store using BTCPay Server — a free, self-hosted and open-source payment gateway.
Experience the simplicity of accepting Bitcoin payments with just a few straightforward steps. You can configure the plugin either automatically or manually, depending on your preferences and requirements.
## Features
## Automatic Configuration
- 0% Fees: Enjoy a payment gateway with no fees. Yes, really!
- No complicated KYC needed, you're your own self-hosted payment gateway
- Automated invoice management and refunds
- Simple and customizable checkout UX, available in 30+ languages
- Direct payments to your wallet, no intermediary
- Reporting and accounting – CSV exports
- Real-time exchange price tracking for correct payment amounts
- Community-driven support
- Extensive documentation and video tutorials
1. Enter Url to your BTCPay Server into "BTCPay Url" field. (e.g. https://mainnet.demo.btcpayserver.org)
2. Click on the "Configure automatically" button to be redirected to the API authorization page on your BTCPay server
3. On BTCPay authorization page: Select the store you want to connect to your NopCommerce (you might need to login first)
4. Click on "Authorize App" button and you will be redirected back to your NopCommerce
3. The "API Key", "BTCPay Store ID" and "Webhook Secret" fields will be automatically filled and a webhook created
4. Click "Save" button at the top right to persist the configuration
5. Congrats, the configuration is now done.
## Getting Started
## Manual Configuration
### Download and installation
Ensure that the following fields are filled out: "BTCPay Url," "API Key," "BTCPay Store ID," and "WebHook Secret."
The plugins can be downloaded through [nopCommerce Marketplace](https://www.nopcommerce.com/marketplace/) or [GitHub](https://github.com/btcpayserver/nopcommerce)
To create the BTCPay API key, [read this](https://docs.btcpayserver.org/VirtueMart/#22-create-an-api-key-and-configure-permissions).
- Note: If you want to use the Refund feature, you must also add the "Create non-approved pull payments" permission. After a refund, an order note is created where you can copy the pull payments link and send to your customer (this order note is also visible by the customer). The customer can request the refund on that page.
For installing the plugin through nopCommerce, you can either upload the plugin directly from nopCommerce `Configuration > Local plugins > Upload plugin or a theme`
To create the BTCPay WebHook, [read this](https://docs.btcpayserver.org/VirtueMart/#23-create-a-webhook-on-btcpay-server) and use the default secret code generated by BTCPay.
- Note: Other than in the guide you need to copy the Url shown in field "Webhook Url" from your configuration screen on NopCommerce.
Ensure the plugin file is in ZIP for successful upload. After uploading, find the plugin in the list, click "Install" next to it, and enable it if needed​.
Alternatively you can manually add upload the plugin to the `/plugins` folder in your nopCommerce directory and restart the application.
Once the plugin is uploaded, make sure to click `Install` button and `Restart application` to apply the changes.
## Plugin configuration
You can configure the plugin either automatically or manually. Automatic setup is much faster and recommended. To begin configuring the plugin, click on the `Configure` button in the
### Automatic Configuration
1. Enter Url to your BTCPay Server into **BTCPay URL** field. (e.g. https://mainnet.demo.btcpayserver.org)
2. Click on the **Configure automatically** button to be redirected to the API authorization page of your BTCPay Server
3. On the authorization page: Select the store you want to connect to your nopCommerce (you might need to login first)
4. Click on "Authorize App" button and you will be redirected back to your nopCommerce
5. The "API Key", "BTCPay Store ID" and "Webhook Secret" fields will be automatically filled and a webhook created
6. Click **Save** button at bottom to persist the configuration.
7. Click **Activate** to enable the plugin. Congrats, the configuration is now complete!
*Note: given the architecture of nopCommerce, it is possible that malfunctions in redirections may occur. Particularly if https is disabled or incorrectly configured. In this case, please opt for manual configuration.*
### Manual Configuration
Ensure that the following fields are filled out:
- BTCPay Url
- BTCPay Store ID
- API Key
- WebHook Secret
#### BTCPay URL
In the BTCPay URL field of your nopCommerce, simply input the link to your self-hosted server or the one hosted by a [third-party provider](https://directory.btcpayserver.org/filter/hosts). For example; https://mainnet.demo.btcpayserver.org
#### BTCPay Store ID
BTCPay **Store ID** can be obtained from your BTCPay Server, in Store Settings > General > Store ID field. Copy it and paste it over in the `BTCPay Store ID` field.
#### Generating the API key
1. To create the **BTCPay API key**, click on the `Account` located at the bottom of the sidebar.
2. Click on the `Manage Account > API Key`.
3. Click on the `Generate API key` button
4. Click on the checkboxes and enable the following permissions:
- View invoices
- Create an invoice
- Modify invoices
- Modify selected stores' webhooks
- View your stores
- Create non-approved pull payments in selected stores (optional)
*Note: To use the [refund feature](https://docs.btcpayserver.org/Refund/#refunds), you must also add the "Create non-approved pull payments" permission. After a refund, an order note is created where you can copy the pull payments link and send to your customer to claim it (this order note is also visible by the customer). The customer can request the refund on that page by filling out refund address.*
#### Generating the webhook
1. In your nopCommerce, copy the "Webhook Url" shown on the bottom of the BTCPay plugin configuration screen.
2. Next, go to your BTCPay Server `Store Settings > Webhooks`
4. Click on the `Create Webhook` button
5. Paste the `Webhook Url` you copied from nopCommerce (step 1) into `Payload URL` field
6. Click on the "Eye" icon next to the `Secret` field to reveal the secret key and copy it.
7. Don't forget to click on the `Add webhook` to apply all the changes.
8. Go back nopCommerce and paste the Secret Key into the `WebHook Secret` field
9. Click save to apply all the changes
7. Click `Activate` to enable the plugin. Congrats, the configuration is now complete!
Now your BTCPay Server is connected to your nopCommerce sucessfully.
## Support
Feel free to join our support channel over at [Mattermost Chat](https://chat.btcpayserver.org/) if you need help or have any further questions.
Feel free to join our support channel over at [Mattermost](https://chat.btcpayserver.org/) or [Telegram](https://t.me/btcpayserver) if you need help or have any further questions.
If experience a bug please [open a bug report](https://github.com/btcpayserver/btcpay-nopCommerce-plugin/issues)
If experience a bug please open an issue in our repository [here]
## License
This plugin is released under the [MIT License](LICENSE).
The non-profit [BTCPay Server Foundation](https://btcpayserver.org) is committed to keeping this powerful payment plugin free forever. Our mission is to enable anyone to accept bitcoin regardless of financial, technical, social or political barriers.
---
Find our latest releases on the [NopCommerce marketplace] or on our [release page]

BIN
nopCommerceAcceptBitcoin.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 984 KiB