Copyright (C) 2019-2023 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.

Edge API for mod-ncip

The purpose of this module is to expose mod-ncip to external applications/3rd party software. It simply passes requests through to the NCIP module (after the API key is authenticated). It does not contain any other functionality

Institutional users should be granted the following permissions in order to use this edge API (because these are required for the NCIP module itself):

    ncip.all
    inventory-storage.items.collection.get
    ui-circulation.settings.overdue-fines-policies
    ui-circulation.settings.lost-item-fees-policies
    automated-patron-blocks.collection.get
    circulation-storage.circulation-rules.get
    manualblocks.collection.get
    

The edge-ncip module is secured via the functionality provided by the edge-common project (via API key).

The configuration for this module conforms to the edge-common project.

https://github.com/folio-org/edge-common

.../ncip/yourapikeygoeshere
.../ncip?apikey=yourapikeygoeshere

See project EDGNCIP at the FOLIO issue tracker.

See the built target/ModuleDescriptor.json for the interfaces that this module requires and provides, the permissions, and the additional module metadata.

SonarQube analysis.

The built artifacts for this module are available. See configuration for repository access, and the Docker image.

Other modules are described, with further FOLIO Developer documentation at dev.folio.org