Klub přatel provides a REST api using django-rest-framework. Django rest framework makes it easy to expose Django models to the outside world. Models are exposed using views that list objects. These lists use pagination.
There are also some views that do not corespond directly to models.
You can find swagger docs here:
Swagger docsIn order to interact with the API you'll need authentification.
Klub přatel supports an OAuth flow for requesting an Access Token. OAuth Application.
You'll want to set the Authorization grant type to "Client credentials".
Furthermore, if you want your application to have access to event data you need to add the can_view_events scope to the scope string.
To test your new application you can request a token using the curl command
curl --header "Content-Type: application/json" --request POST --data '{"grant_type":"client_credentials","client_id":"<id>","client_secret":"<secret>"}' https://test.klub-pratel.cz/api/o/token
You can then use your token like so:
curl -H "Authorization: Bearer <token>" -H "Content-Type: application/json" -X GET https://test.klub-pratel.cz/api/bronto/event/
The endpoint for registering users is /api/register-userprofile. Here are some example contents:
{
"username": "test2",
"password": "foobarbaz",
"first_name": "Test",
"last_name": "Test",
"telephone": "334534534",
"email": "[email protected]",
"userchannels": [
{
"money_account": "obecne_darujme",
"event": "obecne",
"regular_amount": 250,
"regular_frequency": "monthly"
}
]
}
Possible values for regular_frequency are
monthlyquaterlybiannuallyannually
money_account and event should be set to slugs.
You can find event slugs in the admin at /events/event/ for example https://test.klub-pratel.cz/events/event/.
Money account slugs are in the admin at /aklub/bankaccount/ aka https://test.klub-pratel.cz/aklub/bankaccount/
Per user authentification is not supported at this time.
The endpoint https://test.klub-pratel.cz/api/bronto/event/ lists all events.
Creating editing events:
TODO
TODO
TODO
TODO