APIs and protocols supported by Koha

From Koha Wiki

Jump to: navigation, search
Home > Documentation

Contents

RESTful web service calls

Koha has an older web API, but a newer more modern REST API is in development, several endpoints are already available. See New REST API RFC for details.

Koha /svc/ HTTP API

Reports web service

Any report can be set to internal or public to be available in JSON format with and without authentication.

A public report is accessible via a URL that looks like this:

http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID.

An internal report requires authentication and is available from the intranet base URL.

Patrons, circulation, payment etc

SIP2

ILS-DI

ILS-DI is self-documenting, so in an installation where it is enabled, you can get some information about it at the URL:

http://koha-opac.example.org/cgi-bin/koha/ilsdi.pl

Because ILS-DI gives access to all your data (items, patrons...), it should be restricted by allowing IP in the admin interface and/or by disabling services via the server.

For Apache, these rules can be added to restrict public access only to the first and second levels of ILS-DI:

 <IfModule mod_rewrite.c>
   # Rewrite Rules
   RewriteEngine On
   # Restricted ILS-DI Access
   RewriteCond %{QUERY_STRING} !(^($|(\??|(.*&))service=(Describe|GetAvailability|GetRecords|GetAuthorityRecords)))
   RewriteRule ^/cgi-bin/koha/ilsdi\.pl$ - [R=403,L]
 </IfModule>

Because an IP can be easily spoofed, the second way is recommanded.

E-Payment

PayPal

Bug 11622 made it possible to add PayPal as a payment option in the OPAC.

Other options

Bug 19173 makes OPAC online payments pluggable for easier integration with other and local payment methods.

Bibliographic data

Z39.50

Support for Z39.50 is provided by Zebra.

Server

Koha can act as a Z39.50 server.

Client

Koha can also be used as a client to retrieve both bibliographic and authority records from other Z39.50 servers. This is often referred to as copy cataloguing.

SRU

Server

Koha can act as a SRU server.

Client

Koha can also be used as a client to retrieve bibliographic records from other SRU servers.

OAI-PMH

Data Provider

Koha can be set up as a Data Provider (server) by enabling the OAI-PMH system preference.

Service Provider

Koha can currently not act as a Service Provider (client), but Bug 10662 - Build OAI-PMH Harvesting Client aims to change this, in order to make it possible to have Koha ingest/update records via OAI-PMH.

unAPI

OpenSearch

RSS

RSS feeds are provided with different information:

  • Search results
  • News items
  • Lists
  • ...

Authentication

LDAP

CAS

Shibboleth

Mozilla Persona

SSL Client Certificate

OAuth2

Acquisitions

EDIFACT

  • quotes
  • orders
  • invoices
  • responses

See also

Personal tools