Skip to content
Permalink
Browse files

Add some more changes to API documentation

  • Loading branch information...
xijo committed Oct 23, 2019
1 parent 8bbd19f commit c2511252cea2b9a48ed044359e913227b584da04
@@ -71,7 +71,7 @@ about updates and scheduled downtimes.
### **Client API**

1. **General Information**
1. General Information [↓ below](#client-api)
1. General Information [↓ below](#client-api-1)
1. Client Projects [↓ below](#client-projects)
1. Client Authentication [↓ below](#client-authentication)
1. [**Client** Details](sections/client_details.md)
@@ -80,7 +80,7 @@ After everything is set up by betterplace.org (see [How to get it](#how-to-get-i

*Example:*
<pre>
https://www.betterplace.org/de/projects/480/client_donations/new?client_id=ablass&donation_amount=15&donation_client_reference=wZo2aZCjJHA2CONAXxIQHt
https://www.betterplace.org/de/donate/ablass/projects/480?client_reference=wZo2aZCjJHA2CONAXxIQHt&donation_amount=40
</pre>

<table>
@@ -89,7 +89,7 @@ https://www.betterplace.org/de/projects/480/client_donations/new?client_id=ablas
<code>https://www.betterplace.org/</code>
</td>
<td>
Lets start with the domain
Lets start with the domain.
</td>
</tr>
<tr>
@@ -98,54 +98,46 @@ https://www.betterplace.org/de/projects/480/client_donations/new?client_id=ablas
<code>de/</code>
</td>
<td>
The language for the form
The language for the form.
</td>
</tr>
<tr>
<td>
<code>projects/1114/</code>,
<code>fundraising-events/seeds-of-kindness-3/</code>
</td>
<td>
The receiver type and id of the donation.
</td>
</tr>
<tr>
<td>
<code>client_donations/new?client_id=YOUR_APP_ID</code>
<code>donate/YOUR_APP_ID/</code>
</td>
<td>
The path to the donation form. <code>YOUR_APP_ID</code> will be provided by betterplace.org (see <a href="#how-to-get-it">How to get it</a>).
</td>
</tr>
<tr>
<td>
<code>&donation_amount=6</code>
<code>projects/1114</code>,
<code>fundraising-events/seeds-of-kindness-3</code>
</td>
<td>
OPTIONAL: You can pre-set the donation amount in euro
The receiver type and id.
</td>
</tr>
<tr>
<td>
<code>&donation_amount_readonly=true</code>
<code>?client_reference=123</code>
</td>
<td>
OPTIONAL: You can specify if the input field for the donation amount (the default or your pre-set amount) should be readonly. This ways users cannot change the amount (easily). –– This feature is not yet implemented!
OPTIONAL – but this is basically why you would want to use the ThirdPartyApp donation form in the first place! It allows you to give each donation/donor a unique ID in your application. We will send this ID back to you via the callback url. This way you can track which donation went through. This reference should be url safe, e.g. only consist of alphanumeric symbols like a SHA-1 Hash.
<br/><strong>Watch out:</strong> This field must be blank or provide a <em>unique</em> identifier. Using the same identifier twice will prohibit donations. Please keep that in mind if you create sharing urls that contain parameters. If you choose to provide a client_reference, you can use this value to look up the donation afterwards (see <a href="#handling-the-post-donation">Handling the post donation</a>).
</td>
</tr>
<tr>
<td>
<code>&donation_client_reference=123</code>
<code>&donation_amount=40</code>
</td>
<td>
OPTIONAL – but this is basically why you would want to use the ThirdPartyApp donation form in the first place! It allows you to give each donation/donor a unique ID in your application. We will send this ID back to you via the callback url. This way you can track which donation went through. This reference should be url safe, e.g. only consist of alphanumeric symbols like a SHA-1 Hash.
<br/><strong>Watch out:</strong> This field must be blank or provide a <em>unique</em> identifier. Using the same identifier twice will prohibit donations. Please keep that in mind if you create sharing urls that contain parameters. If you choose to provide a client_reference, you can use this value to look up the donation afterwards (see <a href="#handling-the-post-donation">Handling the post donation</a>).
OPTIONAL: You can pre-set the donation amount in euro.
</td>
</tr>
</table>

Please not that the ThirdPartyApp custom donation for does not allow color and layout changes. If you need those, consider using the [integrated donation form (iFrame)](#alternative-solutions).
Please not that the ThirdPartyApp custom donation form does not allow color and layout changes. If you need those, consider using the [integrated donation form (iFrame)](#alternative-solutions).



0 comments on commit c251125

Please sign in to comment.
You can’t perform that action at this time.