Format and structure fixes for docs
This commit is contained in:
Jens Schuppe
parent
4d750b1ab6
commit
8cd714362d
41 changed files with 325 additions and 288 deletions
27
docs/configuration/account.md
Normal file
27
docs/configuration/account.md
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
# Twingle account settings on the Twingle website
|
||||
|
||||
The use of the Twingle API extension requires that you already have a Twingle
|
||||
account and that you make some settings in this account for the connection.
|
||||
|
||||
You will have to provide the following settings in your Twingle account settings
|
||||
in order to send donations to CiviCRM:
|
||||
|
||||
1. API key from your Twingle user
|
||||
2. Site key
|
||||
3. URL
|
||||
|
||||
Important: The URL must always be the complete URL to the CiviCRM REST API
|
||||
endpoint.
|
||||
Examples:
|
||||
|
||||
- Drupal (with the *AuthX* extension): https://example.org/civicrm/ajax/rest
|
||||
- Drupal (legacy
|
||||
method): https://example.org/sites/all/modules/civicrm/extern/rest.php
|
||||
- Wordpress (with CiviCRM <
|
||||
5.25): https://example.org/wp-content/plugins/civicrm/civicrm/extern/rest.php
|
||||
- Wordpress (with CiviCRM
|
||||
5.25+): https://example.org/wp-json/civicrm/v3/rest
|
||||
|
||||
For detailled information, please see
|
||||
the [Twingle documentation](https://support.twingle.de/faq/de-de/9-anbindung-externer-systeme/46-wie-kann-ich-civicrm-mit-twingle-nutzen) (
|
||||
in German language only).
|
||||
32
docs/configuration/civisepa.md
Normal file
32
docs/configuration/civisepa.md
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
# Activating CiviSEPA integration
|
||||
|
||||
The Twingle API extension provides integration with the [
|
||||
*CiviSEPA*](https://civicrm.org/extensions/civisepa-sepa-direct-debit-extension)
|
||||
extension. This allows for managing SEPA mandates and collections with
|
||||
*CiviSEPA* for donations being initiated via a *Twingle* form.
|
||||
|
||||
1. In CiviCRM, go to **Administer**.
|
||||
2. Choose **Twingle API configuration**.
|
||||
|
||||
|
||||
3. Then click on **Configure extension settings**.
|
||||
|
||||
|
||||
4. Tick the boxes **Use CiviSEPA** and **Use CiviSEPA generated reference**.
|
||||
These options can only be activated if CiviSEPA is installed and used. If it
|
||||
is not activated, the administration of SEPA mandates will have to take place
|
||||
in Twingle, which is subject to configuration of your available payment
|
||||
methods.
|
||||
5. Write **TW-** in the **Twingle ID Prefix** field.
|
||||
To avoid overlaps when assigning CiviCRM IDs and Twingle transaction IDs, a
|
||||
prefix should be assigned here, e.g. "TWNGL" or "Twingle" or similar.
|
||||
Attention: The prefix should not be changed later, otherwise problems may
|
||||
occur.
|
||||
6. In the **Protect Recurring Contributions** field select **No**.
|
||||
If you choose Yes, all recurring donations created by Twingle can no longer
|
||||
be changed in CiviCRM, but must then be changed accordingly in Twingle. If no
|
||||
recurring payments are processed via Twingle, but only one-off donations,
|
||||
then this does not need to be activated. Otherwise, we strongly recommend
|
||||
setting the button here to **Yes** so that there are no discrepancies between
|
||||
CiviCRM and Twingle.
|
||||
|
||||
30
docs/configuration/profiles.md
Normal file
30
docs/configuration/profiles.md
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
# Configuring the Twingle Profile in CiviCRM
|
||||
|
||||
The Twingle API extension is being configured through configuration profiles.
|
||||
This allows you to have different sets of configuration, as you might want to
|
||||
handle donation submissions differently, depending on which form was used.
|
||||
Each profile can react to one ore more form IDs being submitted along with
|
||||
donation data.
|
||||
|
||||
1. In CiviCRM, go to **Administer**.
|
||||
2. Choose **Twingle API configuration**.
|
||||
|
||||
|
||||
3. Then click on **Configure profiles**.
|
||||
|
||||
|
||||
4. The Twingle configuration is always done with the help of a profile. Please
|
||||
use the Twingle default profile and click on **Edit**.
|
||||
|
||||
|
||||
5. Then you will identify the Twingle API profile window. Start by entering the
|
||||
corresponding information in the **General settings** section.
|
||||
|
||||
|
||||
6. Define the different payment methods in the Payments section.
|
||||
|
||||
|
||||
7. Make the settings for the groups.
|
||||
|
||||
|
||||
8. When you have made all the settings, please press the **Save** button.
|
||||
82
docs/configuration/user_permissions.md
Normal file
82
docs/configuration/user_permissions.md
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
# User, permissions, and API authentication
|
||||
|
||||
After the installation of the Twingle API extension, various configuration steps
|
||||
must be carried out so that the connection functions smoothly. Among other
|
||||
things, certain configurations must be made on the CMS platform CiviCRM is
|
||||
implemented on.
|
||||
|
||||
Connecting to the Twingle API via CiviCRM's REST interface requires a user with
|
||||
appropriate permissions in your CMS-system.
|
||||
|
||||
You might want to create a specific user role to assign permissions necessary
|
||||
for calling the Twingle API only. This section describes how to accomplish this
|
||||
in *Drupal* and *Wordpress*:
|
||||
|
||||
## New User Role in Drupal
|
||||
|
||||
1. In Drupal, go to **Administration/People/Permissions/Roles**.
|
||||
2. Type Twingle API in the text box and select **Add role**. To the right of
|
||||
your role there will be a *edit role* function and an *edit permissions*
|
||||
button. The *edit permissions* selection will show only the permission
|
||||
selections for the individual role.
|
||||
3. As Permission you only have to select the following entry: **Twingle API:
|
||||
Access Twingle API**.
|
||||
|
||||
## New User Role in Wordpress
|
||||
|
||||
1. In CiviCRM, go to **Administer/User and Permissions (Access Control)**.
|
||||
2. Then select the **WordPress Access Control** link.
|
||||
Here you can adjust the CiviCRM settings for each of the predefined User
|
||||
Roles from WordPress.
|
||||
3. Scroll down. As Permission you only have to select the following entry: *
|
||||
*Twingle API: Access Twingle API**.
|
||||
|
||||
|
||||
|
||||
## New User in Drupal
|
||||
|
||||
1. In Drupal, go to **Administration/People**.
|
||||
2. Then select **Add user**.
|
||||
3. In user name field enter something like **Twingle API**
|
||||
5. In Roles select **Twingle API**.
|
||||
|
||||
## Take over user
|
||||
|
||||
The Twingle API only works correctly if a contact connected to the permissioned
|
||||
user exists in CiviCRM.
|
||||
|
||||
Here, the corresponding steps are described by way of example when using Drupal.
|
||||
|
||||
1. In CiviCRM, go to **Administer**.
|
||||
2. In the **Users and Permissions** section, choose **Synchronize Users to
|
||||
Contacts**.
|
||||
|
||||
|
||||
|
||||
This function checks each user record in Drupal for a contact record in CiviCRM.
|
||||
If there is no corresponding contact record for a user, a new one will be
|
||||
generated. Check this in your CiviCRM contact management.
|
||||
|
||||
|
||||
|
||||
## Assign API key for the Twingle API user
|
||||
|
||||
The Twingle API contact in CiviCRM needs their own API key for authenticating
|
||||
against CiviCRM's REST API endpoint. The API key is assigned with the help of
|
||||
the API Explorer in CiviCRM.
|
||||
|
||||
1. Select the Twingle API contact in CiviCRM.
|
||||
2. Look for the corresponding **CiviCRM ID** and remember the ID.
|
||||
3. Go to **Support/Developper/API Explorer v4**.
|
||||
4. Enter **Contact** in the entity field, **create** in action field and the
|
||||
**ID** of the Twingle User in the **index** field.
|
||||
5. In the values field, select **api_key**.
|
||||
6. Enter the API key for the Twingle API user in the **add value** field.
|
||||
7. Click on **Execute**.
|
||||
|
||||
|
||||
|
||||
!!!note
|
||||
You can also create API keys for contacts by using the [*API
|
||||
Key*](https://civicrm.org/extensions/api-key) extension or with administrator
|
||||
tools like *cv* or *drush*.
|
||||
75
docs/configuration/xcm.md
Normal file
75
docs/configuration/xcm.md
Normal file
|
|
@ -0,0 +1,75 @@
|
|||
# Configuring the Extended Contact Manager extension (XCM)
|
||||
|
||||
After the installation of the Twingle API extension, various configuration steps
|
||||
must be carried out so that the connection functions smoothly. Twingle API
|
||||
depends on the *Extended Contact Manager (XCM)* extension.
|
||||
|
||||
Taking over contact data using the Twingle API means that they may produce
|
||||
duplicates in your CiviCRM contact management. Before contacts are added or
|
||||
updated in CiviCRM a data check should take place to avoid this problem. This
|
||||
data check is handled by the *Extended Contact Manager (XCM)* extension. This
|
||||
extension must be configured accordingly for use with Twingle by defining a
|
||||
corresponding profile.
|
||||
|
||||
## Creating an XCM Profile
|
||||
|
||||
Your first task regarding the Extended Contact Manager extension (XCM)
|
||||
configuration will be to create an XCM profile to be used for the Twingle API.
|
||||
This works best if you copy the *Default* profile.
|
||||
|
||||
1. In CiviCRM, go to **Administer**.
|
||||
|
||||
2. Select **Xtended Contact Matcher (XCM) Configuration** in the **System
|
||||
Settings** section.
|
||||
|
||||
|
||||
|
||||
3. Click on **Copy** in the **Default** profile.
|
||||
|
||||
4. Rename the new profile with **Twingle** in the **Profile name** field.
|
||||
|
||||
|
||||
|
||||
5. Click **Save** at the bottom of this window. In the Profiles overview you can
|
||||
find your new Twingle profile.
|
||||
|
||||
|
||||
|
||||
## Set up the Extended Contact Manager extension
|
||||
|
||||
After you have created the XCM profile, you must enter the configuration
|
||||
settings for the Twingle connection to CiviCRM in this profile. Generally, you
|
||||
will find a description of all the settings in
|
||||
the [Extended Contact Manager (XCM) documentation](https://docs.civicrm.org/xcm/en/latest/configuration/).
|
||||
|
||||
Here you will find as support screenshots of the various sections of the
|
||||
Extended Contact Manager extension (XCM). The settings are only an example.
|
||||
Please adapt the settings to your individual requirements or environnement.
|
||||
|
||||
#### General section
|
||||
|
||||
|
||||
|
||||
#### Update section
|
||||
|
||||
|
||||
|
||||
#### Assignment rules section
|
||||
|
||||
|
||||
|
||||
#### Identified contacts section
|
||||
|
||||
|
||||
|
||||
#### New contact section
|
||||
|
||||
|
||||
|
||||
#### Duplicate section
|
||||
|
||||
|
||||
|
||||
#### Difference Handling section
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue