Skip to content

Commit

Permalink
Add some more changes to API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jaynetics committed Nov 20, 2017
1 parent f00ec75 commit f169df8
Show file tree
Hide file tree
Showing 42 changed files with 8,725 additions and 3,844 deletions.
40 changes: 39 additions & 1 deletion CHANGELOG.md
Expand Up @@ -3,6 +3,44 @@ All notable changes to the betterplace.org API v4 will be documented in this
file. Notifications about changes will also be send to the [mailing list for
service announcements](README.md#mailing-list-for-service-announcements).

## 2017-08-15
### Added
- Added support for `tracking_via` to [donation pledges](sections/client_donation_pledges_list.md) and [forwarding requests](sections/client_forwarding_requests_list.md).


## 2017-07-20
### Added
- Added `summary` to [project details](sections/project_details.md).


## 2017-06-16
### Added
- Added `donations_count` integer to [project details](sections/project_details.md).
- Added `comments_count` integer to [project details](sections/project_details.md).

### Removed
- Removed [endpoint](sections/opinions_list.md) for clients

### Changed
- Deprecated `positive_opinions_count` and `negative_opinions_count` on [project](sections/project_details.md) as well as `positive_or_negative` on [opinion](sections/opinion_list.md)


## 2017-03-03
### Removed
- Removed [Fundraising Challenge] endpoint


## 2016-12-05
### Added
- Added [endpoint](sections/client_donation_pledge_details.md) for [donation pledges](sections/client_donation_pledges_list.md).
- Added [endpoint](sections/client_forwarding_request_details.md) for [forwarding requests](sections/client_forwarding_requests_list.md).


## 2016-12-01
### Removed
- [Opinion Details] endpoint removed


## 2016-06-28
### Changed
- [Opinion Lists](sections/opinions_list.md) now come with the same default order as opinions on betterplace.org - newest first.
Expand Down Expand Up @@ -116,7 +154,7 @@ service announcements](README.md#mailing-list-for-service-announcements).
## 2015-03-05
### Added
- Added API endpoints for fundraising events and linked to them from all
relevent resources. This includes related features for clients as well.
relevant resources. This includes related features for clients as well.
See [here](sections/fundraising_events_list.md) and
[here](sections/fundraising_event_details.md).

Expand Down
234 changes: 131 additions & 103 deletions README.md

Large diffs are not rendered by default.

19 changes: 10 additions & 9 deletions donation_form/third_party_app_donation_form.md
Expand Up @@ -15,10 +15,12 @@ This feature is distinct from our [json-API v4](https://github.com/betterplace/b

### Example Integrations

* [Ablass App](http://www.ablass-app.de/), where you can clean your conscience
* [Donatify me](http://donatify.me/), where you can get Edward to do stuff for you
* [Seeds of Kindness 3](http://yoursiblings.org/portico/seeds-of-kindness-3), where you get a mp3 download link after your donation. Also there is a leader board and referrer-system
* [MADAide](http://madaide.org/?page_id=578), where you can donate to mark a specific piece of the football field with your name
* [Ablass App](http://www.ablass-app.de/), where you can clean your conscience.
* [Tramprennen](https://tramprennen.org/) and [Floßrennen](http://flossrennen.tramprennen.org/) ([GitHub](https://github.com/Club-of-Roam/cor-mgmt)) is a race where you can support one of the teams.
* [MADAide](http://madaide.org/?page_id=578), where you can donate to mark a specific piece of the football field with your name.
* [Tierheim Berlin](http://www.tierheim-geschenke.de/), where you can view and donate to specific needs of the project.
* _(Closed)_ [Donatify me](http://donatify.me/), where you can get Edward to do stuff for you.
* _(Closed)_ [Seeds of Kindness 3](http://yoursiblings.org/portico/seeds-of-kindness-3), where you get a mp3 download link after your donation. Also there is a leader board and referrer-system.


### UserFlow
Expand Down Expand Up @@ -51,7 +53,7 @@ We will check your proposal and get back to you. This is a special service in te
```
* Project url: The URL to your betterplace.org's project.
* Description: A short description of the web application that you plan on building.
* Callback url production: The URL that we redirect users to after a successfull donation (see 'How to use it').
* Callback url production: The URL that we redirect users to after a successful donation (see 'How to use it').
* Callback url staging: This is optional. betterplace.org can provide a staging system that uses this staging callback url.
* Contact e-mail: To keep you posted about changes.
```
Expand Down Expand Up @@ -149,7 +151,7 @@ Please not that the ThirdPartyApp custom donation for does not allow color and l

### Redirect URL and response parameter

This URL is part of the configuration that needs to be done by betterplace.org (see [How to get it](#how-to-get-it)). We will redirect the donor to this URL after a successfull donation. We will also extend the URL with the following reponse parameter.
This URL is part of the configuration that needs to be done by betterplace.org (see [How to get it](#how-to-get-it)). We will redirect the donor to this URL after a successful donation. We will also extend the URL with the following reponse parameter.

*Cool urls dont change:* We cannot change this URL after we created you ThirPartyApp ID. Please consider redirecting inside your application.

Expand All @@ -172,7 +174,7 @@ https://www.you-app.cool/callback.php?status=DONATION_COMPLETE&donation_client_r
<code>?status=DONATION_COMPLETE</code>
</td>
<td>
The status which tells you all is good. Its a bit redundant since there is only this one status ;-)
The status which tells you all is good. It’s a bit redundant since there is only this one status ;-)
</td>
</tr>
<tr>
Expand All @@ -189,7 +191,7 @@ https://www.you-app.cool/callback.php?status=DONATION_COMPLETE&donation_client_r
<code>&receiver_type=group&receiver_id=seeds-of-kindness-3</code>
</td>
<td>
The receiver type and id that you specified when opening the form. "Group" stands for "Fundraising Event".
The receiver type and id that you specified when opening the form. "FundraisingEvent" stands for "Fundraising Event".
</td>
</tr>
<tr>
Expand Down Expand Up @@ -266,4 +268,3 @@ The core for this ThirdPartyApp donation form is the technology that runs our cl
## Feedback

Please send us feedback at product@betterplace.org

0 comments on commit f169df8

Please sign in to comment.