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                   yes: Enable
  13                   no: "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                   yes: Enable
  24                   no: "Disable"
  25             - "the OAuth2 client credentials grant for the REST API. Requires Net::OAuth2::AuthorizationServer installed. [EXPERIMENTAL]"
  26         -
  27             - pref: RESTPublicAnonymousRequests
  28               choices:
  29                 yes: "Enable"
  30                 no: "Disable"
  31             - anonymous access to public routes (that don't require authenticated access)
  32         -
  33             - pref: RESTPublicAPI
  34               choices:
  35                   yes: Enable
  36                   no: "Disable"
  37             - "the /public namespace of the API."
  38     OAI-PMH:
  39         -
  40             - pref: OAI-PMH
  41               choices:
  42                   yes: Enable
  43                   no: 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. OAI-PMH:ConfFile 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                   yes: Enable
  66                   no: Disable
  67             - automatic update of OAI-PMH sets when a bibliographic record is created or updated
  68         -
  69             - Koha's deletedbiblio table
  70             - pref: "OAI-PMH:DeletedRecord"
  71               choices:
  72                   persistent: will never be emptied or truncated (persistent)
  73                   transient: might be emptied or truncated at some point (transient)
  74                   no: will never have any data in it (no)
  75             - "."
  76     ILS-DI:
  77         -
  78             - pref: ILS-DI
  79               choices:
  80                 yes: Enable
  81                 no: Disable
  82             - "ILS-DI services for OPAC users (available at: /cgi-bin/koha/ilsdi.pl)"
  83         -
  84             - Allow IP addresses
  85             - pref: ILS-DI:AuthorizedIPs
  86               class: Text
  87             - 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.
  88     Mana KB:
  89         -
  90             - pref: Mana
  91               choices:
  92                 yes: Enable
  93                 no: Disable
  94                 2: No, let me think about
  95             - 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>
  96         -
  97              - "Security token used to authenticate on Mana KB:"
  98              - pref: ManaToken
  99                class: Text
 100              - Get a security token on the <a href="/cgi-bin/koha/admin/share_content.pl">Mana KB administration page</a>.
 101         -
 102             - 'Fields automatically shared with Mana KB'
 103             - pref: AutoShareWithMana
 104               multiple:
 105                 subscription: Subscriptions
 106     Reporting:
 107         -
 108             - Only return
 109             - pref: SvcMaxReportRows
 110               class: integer
 111             - rows of a report requested via the reports web service.
 112     IdRef:
 113         -
 114             - pref: IdRef
 115               choices:
 116                 yes: Enable
 117                 no: Disable
 118             - the IdRef webservice from the opac detail page. IdRef allows to request authorities from the Sudoc database.
 119             - Please note that this feature is available only for UNIMARC.