Zen

Source string Source string

43/10000 · 43

The string is read only.

English Actions
So as an example if I want "coral" to be at the beginning of the title, I can do this query : http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Title=coral first
Retrieve
My search for http://univ\_lyon3.biblibre.com:9999/biblios?version=1.1&operation=searchRetrieve&query=coral reefs&maximumRecords=1 retrieves just on record. The response looks like this:
ILS-DI
As of writing, the self documenting ILS-DI is the most complete interface. After it has been enabled as described in the :ref:`ILS-DI system preferences <webservices-ils-di-system-preferences-label>` section, the documentation should be available at https://YOURKOHACATALOG/cgi-bin/koha/ilsdi.pl
JSON reports services
Koha implements a JSON reports service for every report saved using the :ref:`Guided reports wizard <guided-report-wizard-label>` or :ref:`Report from SQL <report-from-sql-label>` features.
By default reports will be non-public and only accessible by authenticated users. If a report is explicitly set to *public* it will be accessible without authentication by anyone. This feature should only be used when the data can be shared safely not containing any patron information.
The reports can be accessed using the following URLs:
Public reports
OpacBaseURL/cgi-bin/koha/svc/report?id=REPORTID
Non-public reports
StaffBaseURL/cgi-bin/koha/svc/report?id=REPORTID
There are also some additional parameters available:
Instead of accessing the report by REPORTID you can also use the report's name:
.../cgi-bin/koha/svc/report?name=REPORTNAME
For easier development there is also an option to generate an annotated output of the data. It will generate an array of hashes that include the field names as keys.
.../cgi-bin/koha/svc/report?name=REPORTNAME&annotated=1
Versioned RESTful API effort
There is an ongoing effort to converge the APIs above into a single versioned set of modern RESTful endpoints documented using the OpenAPI standard and available by default under https://YOURKOHACATALOG/api/v1/
OAuth2 client credentials grant
Koha supports the OAuth2 client credentials grant as a means to secure the API for using it from other systems to adhere to current industry standards. More information on the OAuth2 client credentials grant standard `can be found here <https://auth0.com/docs/api-auth/grant/client-credentials>`_.
API key management interface for patrons
In order for API keys to be create for patrons, the system preference :ref:`RESTOAuth2ClientCredentials <restoauth2clientcredentials-label>` **must** be enabled for the option to appear in a patron record.
Navigate to a patron record and select *More > Manage API keys*
|image1336|
If no API keys exist for a patron there will be a message prompting to generate a client id/secret pair
|image1337|
Enter a description for the client id/secret pair and click Save
|image1338|
Koha will generate a client id/secret pair for use to connect to Koha from other third-party systems as an authenticated client

Loading…

User avatar None

Source string added

  1. koha-manual
  2. webservices
  3. English
.../cgi-bin/koha/svc/report?name=REPORTNAME
a year ago
Browse all string changes

Things to check

Ellipsis

The string uses three dots (...) instead of an ellipsis character (…)

Reset

Multiple failing checks

Following checks are failing:
Unchanged translation: Arabic, Czech, German, Spanish, French (Canada), Hindi, Italian, Portuguese, Turkish, Chinese (Traditional), French

Reset

Glossary

English English
No related strings found in the glossary.

String information

Flags
read-only
Source string location
../../source/webservices.rst:350
String age
a year ago
Last updated
4 months ago
Source string age
a year ago
Translation file
string 50