ProPeace/de.systopia.twingle
6
0
Fork 0
Code Issues 2 Pull requests Projects 1 Releases Packages Wiki Activity Actions

Format and structure fixes for docs

Browse source
This commit is contained in:
Jens Schuppe 2023-03-14 15:17:37 +01:00
parent 4d750b1ab6
commit 8cd714362d
41 changed files with 325 additions and 288 deletions
Download patch file Download diff file Expand all files Collapse all files

67
README.md
View file

@ -1,45 +1,42 @@
# CiviCRM extension Twingle API[](https://docs.civicrm.org/twingle/en/latest/#twingle-api "Permanent link")
# Twingle API
Twingle is a payment service provider that makes it possible to create donation forms with various payment options and embed them on websites or integrate them into your homepage. Interested parties can donate via known payment options (e.g. credit card, PayPal). The procedure is also set up and optimised for mobile devices. If you want to use the Twingle fundraising service, you have to set up a corresponding online account.
Twingle is a payment service provider that makes it possible to create donation
forms with various payment options and embed them on websites or integrate them
into your homepage. Interested parties can donate via known payment options (
e.g. credit card, PayPal). The procedure is also set up and optimised for mobile
devices. If you want to use the Twingle fundraising service, you have to set up
a corresponding online account.
For further information about Twingle fundraising follow [this link](https://www.twingle.de/).
For further information about Twingle fundraising
see the [Twingle website](https://www.twingle.de/).
Twingle as fundraising service can be connected to CiviCRM via its API with the extension **Twingle API**.
Twingle as fundraising service can be connected to CiviCRM via its API with the
extension **Twingle API**.
## What advantages does the Twingle API extension offer?
## Features
- Donations from Twingle can be automatically created in CiviCRM and assigned to existing or new contacts and administered yourself in CiviCRM.
* Donations from Twingle can be automatically created as contributions in
CiviCRM and assigned to existing or new contacts and administered in CiviCRM.
* Supporters and contacts of donations can be managed in CiviCRM.
* Donations can be submitted with different payment statuses depending on the
payment type
* SEPA mandates can be created for one-off and recurring payments.
* Donors can be added into groups for receiving newsletters, mailings and
donation receipts.
* A memberships can be set up for a donor.
* Data can be entered in user-defined fields
- Supporters and contacts of donations can be managed yourself in CiviCRM and contacts yourself.
## Configuration
- Donations can be declared as closed or open depending on the payment type
- SEPA mandates can be created for one-off and recurring payments.
- Donors can be entered into groups for newsletters, mailings and donation receipts.
- A memberships can be set up for a donor.
- Data can be entered in user-defined fields
## How to set up the Twingle API extension
Following the successful installation of the Twingle API extension, there is some configuration work to do in order to set up the smooth connection between CiviCRM and Twingle fundraising service.
Following the successful installation of the Twingle API extension, there is
some configuration work to do in order to set up the smooth connection between
CiviCRM and Twingle fundraising service.
You have to carry out the following configuration steps:
- Creating a Twingle user and a user role in your CMS-System (Drupal, Wordpress ...)
- Configuring the Extended Contact Matcher (XCM) in CiviCRM
- Creating a Twingle User and an API key in CiviCRM
- Activating the SEPA connection in CiviCRM
- Configuring the Twingle profile in CiviCRM
- Configuring your Twingle Account on the Twingle website
The Twingle API extension is licensed under [AGPL-3.0](https://github.com/systopia/de.systopia.twingle/blob/master/LICENSE.txt).
* Creating a Twingle user and a user role in your CMS (Drupal, Wordpress, etc.)
* Configuring the *Extended Contact Matcher (XCM)* in CiviCRM
* Creating a Twingle User and an API key in CiviCRM
* Activating the SEPA connection in CiviCRM (optional)
* Configuring the Twingle profile in CiviCRM
* Configuring your Twingle Account on the Twingle website