ihatemoney_ynh/docs/api.rst

The REST API
############

All of what's possible to do with the website is also possible via a web API.
This document explains how the API is organized and how you can query it.

By default, the API talks JSON. There is no other way to speak with it
currently.

Overall organisation
====================

You can access three different things: projects, members and bills. You can
also get the balance for a project.

For the examples, I'm using curl, feel free to use whatever you want to do the
same thing, curl is not a requirement.

Authentication
--------------

To interact with bills and members, and to do something else than creating
a project, you need to be authenticated. The only way to authenticate yourself
currently is using the "basic" HTTP authentication.

If you don't want your credentials to pass in clear trought the network, you
can use the ssl endpoint at https://ihatemoney.notmyidea.org

For instance, here is how to see the what's in a project, using curl::

    $ curl --basic -u demo:demo http://ihatemoney.notmyidea.org/api/projects/demo

Projects
--------

You can't list projects, for security reasons. But you can create, update and
delete one directly from the API.

The URLs are `/api/projects` and `/api/projects/<identifier>`.

Creating a project
~~~~~~~~~~~~~~~~~~

A project needs the following arguments:

* `name`: The project name (string)
* `id`: the project identifier (string without special chars or spaces)
* `password`: the project password / secret code (string)
* `contact_email`: the contact email

::

    $ curl -X POST https://ihatemoney.notmyidea.org/api/projects \
    -d 'name=yay&id=yay&password=yay&contact_email=yay@notmyidea.org'
    "yay"

As you can see, the API retuns the identifier of the project

Getting information about the project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Getting information about the project::


    $ curl --basic -u demo:demo http://ihatemoney.notmyidea.org/api/projects/demo
    {
        "name": "demonstration", 
        "contact_email": "demo@notmyidea.org", 
        "password": "demo", 
        "id": "demo",
        "active_members": [{"activated": true, "id": 31, "name": "Arnaud"}, 
                            {"activated": true, "id": 32, "name": "Alexis"}, 
                            {"activated": true, "id": 33, "name": "Olivier"}, 
                            {"activated": true, "id": 34, "name": "Fred"}], 
        "members": [{"activated": true, "id": 31, "name": "Arnaud"}, 
                    {"activated": true, "id": 32, "name": "Alexis"}, 
                    {"activated": true, "id": 33, "name": "Olivier"}, 
                    {"activated": true, "id": 34, "name": "Fred"}], 
    }


Updating a project
~~~~~~~~~~~~~~~~~~

Updating a project is done with the `PUT` verb::

    $ curl --basic -u yay:yay -X PUT\
    http://ihatemoney.notmyidea.org/api/projects/yay -d\
    'name=yay&id=yay&password=yay&contact_email=youpi@notmyidea.org'

Deleting a project
~~~~~~~~~~~~~~~~~~

Just send a DELETE request ont the project URI ::

    $ curl --basic -u demo:demo -X DELETE http://ihatemoney.notmyidea.org/api/projects/demo

Members
-------

You can get all the members with a `GET` on `/api/projects/<id>/members`::

    $ curl --basic -u demo:demo http://ihatemoney.notmyidea.org/api/projects/demo/members\
    [{"activated": true, "id": 31, "name": "Arnaud"}, 
     {"activated": true, "id": 32, "name": "Alexis"}, 
     {"activated": true, "id": 33, "name": "Olivier"},
     {"activated": true, "id": 34, "name": "Fred"}]

Add a member with a `POST` request on `/api/projects/<id>/members`::

    $ curl --basic -u demo:demo -X POST\
    http://ihatemoney.notmyidea.org/api/projects/demo/members -d 'name=tatayoyo' 
    35

You can also `PUT` a new version of a member (changing its name)::

    $ curl --basic -u demo:demo -X PUT\
    http://ihatemoney.notmyidea.org/api/projects/demo/members/36\
    -d 'name=yeaaaaah'
    {"activated": true, "id": 36, "name": "yeaaaaah"}

Delete a member with a `DELETE` request on `/api/projects/<id>/members/<member-id>`::

    $ curl --basic -u demo:demo -X DELETE\
    http://ihatemoney.notmyidea.org/api/projects/demo/members/35 
    "OK

Bills
-----

You can get the list of bills by doing a `GET` on `/api/projects/<id>/bills` ::

    $ curl --basic -u demo:demo http://ihatemoney.notmyidea.org/api/projects/demo/bills

Add a bill with a `POST` query on `/api/projects/<id>/bills`. you need the
following params:

* `date`: the date of the bill. (yy-mm-dd)
* `what`: what have been payed
* `payer`: by who ? (id)
* `payed_for`: list of ids
* `amount`: amount payed

Returns the id of the created bill ::

    $ curl --basic -u demo:demo -X POST\
    http://ihatemoney.notmyidea.org/api/projects/demo/bills\
    -d "date=2011-09-10&what=raclette&payer=31&payed_for=31&amount=200"
    80

You can also `PUT` a new version of the bill at
`/api/projects/<id>/bills/<bill-id>`::

    $ curl --basic -u demo:demo -X PUT\
    http://ihatemoney.notmyidea.org/api/projects/demo/bills/80\
    -d "date=2011-09-10&what=raclette&payer=31&payed_for=31&amount=250"
    80

And you can of course `DELETE` them at `/api/projects/<id>/bills/<bill-id>`::

    $ curl --basic -u demo:demo -X DELETE\
    http://ihatemoney.notmyidea.org/api/projects/demo/bills/80\
    "OK"