koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/web_services.pref

   1 Web services:
   2     REST API:
   3         -
   4             - pref: RESTBasicAuth
   5               choices:
   6                   yes: Enable
   7                   no: "Disable"
   8             - '<a href="https://www.w3.org/Protocols/HTTP/1.0/spec.html#BasicAA" target="_blank">Basic authentication</a> for the REST API.'
   9         -
  10             - "Set the default number of results returned by the REST API endpoints to"
  11             - pref: "RESTdefaultPageSize"
  12               class: integer
  13             - "per page."
  14         -
  15             - pref: RESTOAuth2ClientCredentials
  16               choices:
  17                   yes: Enable
  18                   no: "Disable"
  19             - "the OAuth2 client credentials grant for the REST API. Requires Net::OAuth2::AuthorizationServer installed. [EXPERIMENTAL]"
  20         -
  21             - pref: RESTPublicAPI
  22               choices:
  23                   yes: Enable
  24                   no: "Disable"
  25             - "the /public namespace of the API."
  26     OAI-PMH:
  27         -
  28             - pref: OAI-PMH
  29               choices:
  30                   yes: Enable
  31                   no: Disable
  32             - "Koha's"
  33             - '<a href="http://www.openarchives.org/pmh/">OAI-PMH</a> server.'
  34         -
  35             - Identify records at this site with the prefix
  36             - pref: "OAI-PMH:archiveID"
  37             - '.  Please, insert prefix without ending colon (":") char. The archiveID should respect OAI specification. See '
  38             - '<a href="http://www.openarchives.org/OAI/2.0/guidelines-oai-identifier.htm">Implementation guidelines</a>. '
  39             - 'Example: "oai:example-library.org"'
  40         -
  41             - Only return
  42             - pref: "OAI-PMH:MaxCount"
  43               class: integer
  44             - records at a time in response to a ListRecords or ListIdentifiers query.
  45         -
  46             - "YAML OAI Koha server configuration file:"
  47             - pref: "OAI-PMH:ConfFile"
  48               class: file
  49             - . If empty, Koha OAI Server operates in normal mode, otherwise it operates in extended mode. In extended mode, it's possible to parameter other formats than marcxml or Dublin Core. OAI-PMH:ConfFile specify a YAML configuration file which list available metadata formats and XSL file used to create them from marcxml records.
  50         -
  51             - pref: "OAI-PMH:AutoUpdateSets"
  52               choices:
  53                   yes: Enable
  54                   no: Disable
  55             - automatic update of OAI-PMH sets when a bibliographic record is created or updated
  56         -
  57             - Koha's deletedbiblio table
  58             - pref: "OAI-PMH:DeletedRecord"
  59               choices:
  60                   persistent: will never be emptied or truncated (persistent)
  61                   transient: might be emptied or truncated at some point (transient)
  62                   no: will never have any data in it (no)
  63             - "."
  64     ILS-DI:
  65         -
  66             - pref: ILS-DI
  67               choices:
  68                 yes: Enable
  69                 no: Disable
  70             - "ILS-DI services for OPAC users (available at: /cgi-bin/koha/ilsdi.pl)"
  71         -
  72             - Allow IP addresses
  73             - pref: ILS-DI:AuthorizedIPs
  74               class: Text
  75             - to use the ILS-DI services (when enabled). Separate the IP addresses with commas and without spaces. Leave the field blank to allow any IP address.
  76     Mana KB:
  77         -
  78             - pref: Mana
  79               choices:
  80                 yes: Enable
  81                 no: Disable
  82                 2: No, let me think about
  83             - submissions to Mana KB. Mana centralizes information between other Koha installations to facilitate the creation of new subscriptions, vendors, reports, etc. You can search, share, import, and comment on the content of Mana. The information shared with Mana KB is shared under the <a href="https://creativecommons.org/choose/zero/">CC-0 license</a>
  84         -
  85              - "Security token used to authenticate on Mana KB:"
  86              - pref: ManaToken
  87                class: Text
  88              - Get a security token on the <a href="/cgi-bin/koha/admin/share_content.pl">Mana KB administration page</a>.
  89         -
  90             - 'Fields automatically shared with Mana KB'
  91             - pref: AutoShareWithMana
  92               multiple:
  93                 subscription: Subscriptions
  94     Reporting:
  95         -
  96             - Only return
  97             - pref: SvcMaxReportRows
  98               class: integer
  99             - rows of a report requested via the reports web service.
 100     IdRef:
 101         -
 102             - pref: IdRef
 103               choices:
 104                 yes: Enable
 105                 no: Disable
 106             - the IdRef webservice from the opac detail page. IdRef allows to request authorities from the Sudoc database.
 107             - Please note that this feature is available only for UNIMARC.