ProPeace/de.forumzfd.twinglecampaign
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

📓 add documentation

Browse source
This commit is contained in:
Marc Michalsky forumZFD 2021-04-11 19:55:59 +02:00
parent 88fb74bd6f
commit 0ba0674412
Signed by untrusted user who does not match committer: marc.koch
GPG key ID: 12406554CFB028B9
19 changed files with 172 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/API_Wrapper.md Normal file
View file

@ -0,0 +1,15 @@
# API Wrapper
The **Twingle API** extension uses profiles to process every incoming donation. When Twingle calls the
*TwingleDonation.submit* API, provided by the **Twingle API** extension, the API assigns the donation to the
corresponding profile by looking up the project id which comes with the call. The profile settings then specifies how
the donation should be treated.
![TwingleDonation.submit](../images/TwingleDonation.submit.png)
The **Twingle Campaign** extension puts an API wrapper around the *TwingleDonation.submit* API. This first it searches
the call for either a project id, an event id or a campaign id and depending on the result, it searches CiviCRM for the
![API Wrapper](../images/API_Wrapper.png)
Furthermore, the API wrapper enables you to create soft credits for peer-to-peer event initiators.