almet/ihatemoney
1
0
Fork 0
mirror of https://github.com/spiral-project/ihatemoney.git synced 2025-04-28 17:32:38 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

API docs: new current_password field

Browse source
This commit is contained in:
Baptiste Jonglez 2023-07-29 11:59:19 +02:00 committed by zorun
parent 73c8a31dd2
commit 3e5cd9e04e
1 changed files with 15 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
docs/api.md
View file

@ -34,9 +34,9 @@ the token (of course, you need to authenticate):
$ curl --basic -u demo:demo https://ihatemoney.org/api/projects/demo/token $ curl --basic -u demo:demo https://ihatemoney.org/api/projects/demo/token
{"token": "WyJ0ZXN0Il0.Rt04fNMmxp9YslCRq8hB6jE9s1Q"} {"token": "WyJ0ZXN0Il0.Rt04fNMmxp9YslCRq8hB6jE9s1Q"}
Make sure to store this token securely: it allows full access to the Make sure to store this token securely: it allows almost full access to the
project. For instance, use it to obtain information about the project project. For instance, use it to obtain information about the project
(replace PROJECT_TOKEN with the actual token): (replace `PROJECT_TOKEN` with the actual token):
$ curl --oauth2-bearer "PROJECT_TOKEN" https://ihatemoney.org/api/projects/demo $ curl --oauth2-bearer "PROJECT_TOKEN" https://ihatemoney.org/api/projects/demo
@ -51,7 +51,8 @@ simply create an URL of the form:
https://ihatemoney.org/demo/join/PROJECT_TOKEN https://ihatemoney.org/demo/join/PROJECT_TOKEN
Such a link grants full access to the project associated with the token. Such a link grants read-write access to the project associated with the token,
but it does not allow to change project settings.
### Projects ### Projects
@ -67,8 +68,8 @@ A project needs the following arguments:
- `name`: the project name (string) - `name`: the project name (string)
- `id`: the project identifier (string without special chars or - `id`: the project identifier (string without special chars or
spaces) spaces)
- `password`: the project password / secret code (string) - `password`: the project password / private code (string)
- `contact_email`: the contact email (string) - `contact_email`: the contact email, used to recover the private code (string)
Optional arguments: Optional arguments:
@ -83,7 +84,9 @@ Here is the command:
-d 'name=yay&id=yay&password=yay&contact_email=yay@notmyidea.org' -d 'name=yay&id=yay&password=yay&contact_email=yay@notmyidea.org'
"yay" "yay"
As you can see, the API returns the identifier of the project. As you can see, the API returns the identifier of the project. It might be different
from what you requested, because the ID is normalized (remove special characters,
change to lowercase, etc).
#### Getting information about the project #### Getting information about the project
@ -108,7 +111,12 @@ Updating a project is done with the `PUT` verb:
$ curl --basic -u yay:yay -X PUT\ $ curl --basic -u yay:yay -X PUT\
https://ihatemoney.org/api/projects/yay -d\ https://ihatemoney.org/api/projects/yay -d\
'name=yay&id=yay&password=yay&contact_email=youpi@notmyidea.org' 'name=yay&id=yay&current_password=yay&password=newyay&contact_email=youpi@notmyidea.org'
You need to give the current private code as the `current_password` field. This is a security
measure to ensure that knowledge of an auth token is not enough to update settings.
Note that in any case you can never change the ID of a project.
#### Deleting a project #### Deleting a project