|
Lines 767-775
info:
Link Here
|
| 767 |
name: Koha Development Team |
767 |
name: Koha Development Team |
| 768 |
url: https://koha-community.org/ |
768 |
url: https://koha-community.org/ |
| 769 |
description: | |
769 |
description: | |
| 770 |
## Introduction |
770 |
## Background |
| 771 |
|
771 |
|
| 772 |
This API is documented in **OpenAPI format**. |
772 |
The API supports two sets of endpoints, one targetted at library staff and the other at at library users. |
|
|
773 |
|
| 774 |
Those endpoints under the `/public` path are aimed at delivering functionality tailored to library users and offer |
| 775 |
a more restricted set of functions, overrides and data in thier responses for data privacy and library policy |
| 776 |
reasons. Many of these endpoints do not require authentication for fetching public data, though an authenticated |
| 777 |
session will expose additional options and allow users to see more data where it is part of their own record. |
| 778 |
|
| 779 |
All other endpoints are targetted at the staff interface level and allow for additional functionality and a more |
| 780 |
unrestricted view of data. These endpoints, however, have a level of redaction built in for resources that the |
| 781 |
api consumer should not have access to. For example, user data for users who do not belong to the same library |
| 782 |
or library group of your api user will be reduced to just minimum neccesary for a valid response. Object keys will |
| 783 |
be consistent for all responses, but their values may be removed depending on access. |
| 773 |
|
784 |
|
| 774 |
## Authentication |
785 |
## Authentication |
| 775 |
|
786 |
|
|
Lines 782-787
info:
Link Here
|
| 782 |
Both _Basic authentication_ and the _OAuth2_ flow, need to be enabled |
793 |
Both _Basic authentication_ and the _OAuth2_ flow, need to be enabled |
| 783 |
by system preferences. |
794 |
by system preferences. |
| 784 |
|
795 |
|
|
|
796 |
## Authorization |
| 797 |
|
| 798 |
The API uses existing user profiles to restrict access to resources based on user permissions and the library the |
| 799 |
API user is assigned to. This may result, at times, in resources being returned in a redacted form with all keys |
| 800 |
present but sensative values nulled. |
| 801 |
|
| 802 |
We do not yet support OAuth Scopes or the Authorization Code grant flow. |
| 803 |
|
| 785 |
## Errors |
804 |
## Errors |
| 786 |
|
805 |
|
| 787 |
The API uses standard HTTP status codes to indicate the success or failure |
806 |
The API uses standard HTTP status codes to indicate the success or failure |
| 788 |
- |
|
|