Some endpoints are paginated, because they provides many data. Other provides optional pagination. You can ask for pagination on your requests, by providing the GET parameters page and per_page (when it’s available). The meta-data about pagination will be returned in the headers, following RFC-5988 standard for web linking. It uses headers Link, Total and Per-Page.
Authentication is done using Authorization header. You just have to set header Authorization to Token token=YOUR_TOKEN for every request.
Depending on your client, you may have to set header Accept: application/json for every request, otherwise some clients may request html by default which will result in error.
Everywhere in the OpenAPI amounts are reported in cents. For exemple, if you get { "amount" : 1000 }, from the OpenAPI, this means that the price is 10 € (or whatever your currency is).
| Resource | Description |
|---|---|
| GET /open_api/v1/accounting | Accounting lines |
| Resource | Description |
|---|---|
| GET /open_api/v1/availabilities | Availabilities index |
| Resource | Description |
|---|---|
| GET /open_api/v1/bookable_machines | Bookable machines index |
| Resource | Description |
|---|---|
| GET /open_api/v1/events | Events index |
| Resource | Description |
|---|---|
| GET /open_api/v1/invoices | Invoices index |
| GET /open_api/v1/invoices/:id/download | Download an invoice |
| Resource | Description |
|---|---|
| GET /open_api/v1/machines | Machines index |
| POST /open_api/v1/machines | Create a machine |
| PATCH /open_api/v1/machines/:id | Update a machine |
| GET /open_api/v1/machines/:id | Show a machine |
| DELETE /open_api/v1/machines/:id | Delete a machine |
| Resource | Description |
|---|---|
| GET /open_api/v1/plan_categories | Plans categories index |
| Resource | Description |
|---|---|
| GET /open_api/v1/plans | Plans index |
| GET /open_api/v1/plans/:id | Shows a plan |
| Resource | Description |
|---|---|
| GET /open_api/v1/prices | Prices index |
| Resource | Description |
|---|---|
| GET /open_api/v1/reservations | Reservations index |
| Resource | Description |
|---|---|
| GET /open_api/v1/spaces | Spaces index |
| GET /open_api/v1/spaces/:id | Show a space |
| Resource | Description |
|---|---|
| GET /open_api/v1/subscriptions | Subscriptions index |
| Resource | Description |
|---|---|
| GET /open_api/v1/trainings | Trainings index |
| Resource | Description |
|---|---|
| GET /open_api/v1/user_trainings | User trainings index |
| Resource | Description |
|---|---|
| GET /open_api/v1/users | Users index |