|
Lines 23-28
info:
Link Here
|
| 23 |
|
23 |
|
| 24 |
This API is documented in **OpenAPI format**. |
24 |
This API is documented in **OpenAPI format**. |
| 25 |
|
25 |
|
|
|
26 |
## Authentication |
| 27 |
|
| 28 |
The API supports the following authentication mechanisms |
| 29 |
|
| 30 |
* Basic authentication |
| 31 |
* OAuth2 (client credentials grant) |
| 32 |
* Cookie-based |
| 33 |
|
| 34 |
Both _Basic authentication_ and the _OAuth2_ flow, need to be enabled |
| 35 |
on the system preferences. |
| 36 |
|
| 37 |
## Errors |
| 38 |
|
| 39 |
The API uses standard HTTP status codes to indicate the success or failure |
| 40 |
of the API call. The body of the response will be JSON in the following format: |
| 41 |
|
| 42 |
``` |
| 43 |
{ |
| 44 |
"error": "patron not found" |
| 45 |
} |
| 46 |
``` |
| 47 |
|
| 48 |
Note: Some routes might offer additional attributes in their error responses but that's |
| 49 |
subject to change and thus not documented. |
| 50 |
|
| 26 |
## Special headers |
51 |
## Special headers |
| 27 |
|
52 |
|
| 28 |
### x-koha-library |
53 |
### x-koha-library |
| 29 |
- |
|
|