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

   1 Web services:
   2     General:
   3         -
   4             - "Set the Access-Control-Allow-Origin header to"
   5             - pref: 'AccessControlAllowOrigin'
   6               class: Text
   7             - "."
   8     REST API:
   9         -
  10             - pref: RESTBasicAuth
  11               choices:
  12                   1: Enable
  13                   0: "Disable"
  14             - '<a href="https://www.w3.org/Protocols/HTTP/1.0/spec.html#BasicAA" target="_blank">Basic authentication</a> for the REST API.'
  15         -
  16             - "Set the default number of results returned by the REST API endpoints to"
  17             - pref: "RESTdefaultPageSize"
  18               class: integer
  19             - "per page."
  20         -
  21             - pref: RESTOAuth2ClientCredentials
  22               choices:
  23                   1: Enable
  24                   0: "Disable"
  25             - "the OAuth2 client credentials grant for the REST API. Requires Net::OAuth2::AuthorizationServer installed. [EXPERIMENTAL]"
  26         -
  27             - pref: RESTPublicAnonymousRequests
  28               choices:
  29                 1: "Enable"
  30                 0: "Disable"
  31             - anonymous access to public routes (that don't require authenticated access)
  32         -
  33             - pref: RESTPublicAPI
  34               choices:
  35                   1: Enable
  36                   0: "Disable"
  37             - "the /public namespace of the API."
  38     OAI-PMH:
  39         -
  40             - pref: OAI-PMH
  41               choices:
  42                   1: Enable
  43                   0: Disable
  44             - "Koha's"
  45             - '<a href="http://www.openarchives.org/pmh/">OAI-PMH</a> server. (available at: /cgi-bin/koha/oai.pl?verb=Identify)'
  46         -
  47             - Identify records at this site with the prefix
  48             - pref: "OAI-PMH:archiveID"
  49             - '.  Please, insert prefix without ending colon (":") char. The archiveID should respect OAI specification. See '
  50             - '<a href="http://www.openarchives.org/OAI/2.0/guidelines-oai-identifier.htm">Implementation guidelines</a>. '
  51             - 'Example: "oai:example-library.org"'
  52         -
  53             - Only return
  54             - pref: "OAI-PMH:MaxCount"
  55               class: integer
  56             - records at a time in response to a ListRecords or ListIdentifiers query.
  57         -
  58             - "YAML OAI Koha server configuration file:"
  59             - pref: "OAI-PMH:ConfFile"
  60               class: file
  61             - . 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. <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=OAI-PMH:ConfFile">OAI-PMH:ConfFile</a> specify a YAML configuration file which list available metadata formats and XSL file used to create them from marcxml records.
  62         -
  63             - pref: "OAI-PMH:AutoUpdateSets"
  64               choices:
  65                   1: Enable
  66                   0: Disable
  67             - automatic update of OAI-PMH sets when a bibliographic or item record is created or updated.
  68         -
  69             - pref: "OAI-PMH:AutoUpdateSetsEmbedItemData"
  70               choices:
  71                   1: Enable
  72                   0: Disable
  73             - embedding of item data when automatically updating OAI-PMH sets.
  74             - <br><strong>NOTE:</strong> This needs <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=OAI-PMH:AutoUpdateSets">OAI-PMH:AutoUpdateSets</a> syspref to be enabled.
  75         -
  76             - Koha's deletedbiblio table
  77             - pref: "OAI-PMH:DeletedRecord"
  78               choices:
  79                   persistent: will never be emptied or truncated (persistent)
  80                   transient: might be emptied or truncated at some point (transient)
  81                   no: will never have any data in it (no)
  82             - "."
  83     ILS-DI:
  84         -
  85             - pref: ILS-DI
  86               choices:
  87                 1: Enable
  88                 0: Disable
  89             - "ILS-DI services for OPAC users (available at: /cgi-bin/koha/ilsdi.pl)"
  90         -
  91             - Allow IP addresses
  92             - pref: ILS-DI:AuthorizedIPs
  93               class: Text
  94             - 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.
  95     Mana KB:
  96         -
  97             - pref: Mana
  98               choices:
  99                 1: Enable
 100                 0: Disable
 101                 2: No, let me think about
 102             - 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>
 103         -
 104              - "Security token used to authenticate on Mana KB:"
 105              - pref: ManaToken
 106                class: Text
 107              - Get a security token on the <a href="/cgi-bin/koha/admin/share_content.pl">Mana KB administration page</a>.
 108         -
 109             - 'Fields automatically shared with Mana KB:'
 110             - pref: AutoShareWithMana
 111               multiple:
 112                 subscription: subscriptions
 113     Reporting:
 114         -
 115             - Only return
 116             - pref: SvcMaxReportRows
 117               class: integer
 118             - rows of a report requested via the reports web service.
 119     IdRef:
 120         -
 121             - pref: IdRef
 122               choices:
 123                 1: Enable
 124                 0: Disable
 125             - the IdRef web service from the OPAC detail page. IdRef allows requests for authorities from the Sudoc database.
 126             - Please note that this feature is available only for UNIMARC.