Steps to setting up MOD-NCIP
...
- If you are using the edge-ncip module to allow external access to mod-ncip you will have to create a key that relates to this user. See the edge-common module for more details. What you will end up with is an API key you can use to represent this user. You will be able to provide whomever will be calling your NCIP module externally with a link that will look something like this: http://thedirecturltomyexternalncipmodule/ncip?apikey=eyJzIjoiSkFucGg0Wmw2OFd4ZkRBdnabcedefsgeJ1IjoibXlsdWlkIn0 The key can also be sent through in the header of the requests. The edge-common module documentation describes the ways you can use the apiKey. The apiKey is the method of authentication for external users of your NCIP module.
Step #2 - Decide on and set up configuration values.
...
When you have decided on and setup (where needed) these values in FOLIO you will have to make API calls to the configuration module to set the values the NCIP module will be looking forset them in mod-configuration using API calls.
There are is an example Python scripts script in github that will create these example configuration values for you and then and a second script to set them in mod-config. In these examples the value 'ReShare' is set as the configName for each of the configuration values. This means that when the NCIP module receive receives requests with the 'FromAgencyId' value of ReShare, will apply to these configuration values.
Mod-NCIP includes a utility to validate the configuration values are valid. If you send a GET request to: http://myokapiurl/ncipconfigcheck it will attempt to lookup the values you set in mod-configuration to make sure those values exist in FOLIO (for those that need to exist in FOLIO).
Link to a Python script that sets up the example values in FOLIO.
...