REST api RFCs
From Koha Wiki
The purpose of this page, is to collect references to all RFCs related to the REST api. It is organized by API version. V1 is proposed to be kept until the API covers a reasonable amount of endpoints.
All endpoints and attribute names should respect the terminology guidelines. Terminology changes are discussed as needed on developer meetings. Controller's code needs to respect the project's Coding guidelines and the supplemental API coding guidelines.
Note: for readability purposes, endpoint routes are shortened on this pages, the /api/<version> prefix is omitted. As an example, /patrons stands for /api/v1/patrons in version 1.
Version 1 (in development)
Special use cases handling
|Use case||Decision status||Implementation status||Koha version|
The API supports several authentication mechanisms:
|Protocol||Implementation status||Koha version|
|OAuth2 - Client credentials||Implemented||18.05|