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: RESTPublicAPI
  28               choices:
  29                   yes: Enable
  30                   no: "Disable"
  31             - "the /public namespace of the API."
  32     OAI-PMH:
  33         -
  34             - pref: OAI-PMH
  35               choices:
  36                   yes: Enable
  37                   no: Disable
  38             - "Koha's"
  39             - '<a href="http://www.openarchives.org/pmh/">OAI-PMH</a> server. (available at: /cgi-bin/koha/oai.pl?verb=Identify)'
  40         -
  41             - Identify records at this site with the prefix
  42             - pref: "OAI-PMH:archiveID"
  43             - '.  Please, insert prefix without ending colon (":") char. The archiveID should respect OAI specification. See '
  44             - '<a href="http://www.openarchives.org/OAI/2.0/guidelines-oai-identifier.htm">Implementation guidelines</a>. '
  45             - 'Example: "oai:example-library.org"'
  46         -
  47             - Only return
  48             - pref: "OAI-PMH:MaxCount"
  49               class: integer
  50             - records at a time in response to a ListRecords or ListIdentifiers query.
  51         -
  52             - "YAML OAI Koha server configuration file:"
  53             - pref: "OAI-PMH:ConfFile"
  54               class: file
  55             - . 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.
  56         -
  57             - pref: "OAI-PMH:AutoUpdateSets"
  58               choices:
  59                   yes: Enable
  60                   no: Disable
  61             - automatic update of OAI-PMH sets when a bibliographic record is created or updated
  62         -
  63             - Koha's deletedbiblio table
  64             - pref: "OAI-PMH:DeletedRecord"
  65               choices:
  66                   persistent: will never be emptied or truncated (persistent)
  67                   transient: might be emptied or truncated at some point (transient)
  68                   no: will never have any data in it (no)
  69             - "."
  70     ILS-DI:
  71         -
  72             - pref: ILS-DI
  73               choices:
  74                 yes: Enable
  75                 no: Disable
  76             - "ILS-DI services for OPAC users (available at: /cgi-bin/koha/ilsdi.pl)"
  77         -
  78             - Allow IP addresses
  79             - pref: ILS-DI:AuthorizedIPs
  80               class: Text
  81             - 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.
  82     Mana KB:
  83         -
  84             - pref: Mana
  85               choices:
  86                 yes: Enable
  87                 no: Disable
  88                 2: No, let me think about
  89             - 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>
  90         -
  91              - "Security token used to authenticate on Mana KB:"
  92              - pref: ManaToken
  93                class: Text
  94              - Get a security token on the <a href="/cgi-bin/koha/admin/share_content.pl">Mana KB administration page</a>.
  95         -
  96             - 'Fields automatically shared with Mana KB'
  97             - pref: AutoShareWithMana
  98               multiple:
  99                 subscription: Subscriptions
 100     Reporting:
 101         -
 102             - Only return
 103             - pref: SvcMaxReportRows
 104               class: integer
 105             - rows of a report requested via the reports web service.
 106     IdRef:
 107         -
 108             - pref: IdRef
 109               choices:
 110                 yes: Enable
 111                 no: Disable
 112             - the IdRef webservice from the opac detail page. IdRef allows to request authorities from the Sudoc database.
 113             - Please note that this feature is available only for UNIMARC.