Node module for interacting with the NYPL Platform API
npm i @nypl/nypl-data-api-client --saveInitialize a client (see ClientConstructorOptions):
const NyplClient = require('@nypl/nypl-data-api-client')
const client = new NyplClient({
base_url: 'http://[FQDN].com/api/v0.1/',
oauth_key: 'oauth-key',
oauth_secret 'top-secret-oauth-secret',
oauth_url: 'https://[fqdn]/'
})See usage.md for complete documentation of Client methods and use.
(Usage doc is generated via ./node_modules/.bin/jsdoc2md lib/client.js > usage.md.)
To authenticate and fetch a bib (all GETs authenticate first, by default):
try {
const resp = await client.get('bibs/sierra-nypl/17746307')
const bib = resp.data
console.log('Got bib: ' + bib.title)
} catch (e) => {
console.error('Error authenticating or fetching bib: ', e)
}To get the "Item" stream schema, which doesn't require authentication:
const resp = await client.get('current-schemas/Item', { authenticate: false })
const schema = resp.data
// Now we can build an avro encoder by parsing the escaped "schema" prop:
const avroType = require('avsc').parse(JSON.parse(schema.schema))To get patron id 12345678 (note you must auth with an account that has the 'read:patron' role):
const resp = await client.get('patrons/12345678')
const patron = resp.data
if (!patron) throw new Error('Could not find patron')
const pType = Object.keys(patron.fixedFields).map((key) => patron.fixedFields[key])
.filter((fixed) => fixed.label === 'Patron Type')[0]
.value
const name = patron.names[0]
const barcode = patron.barCodes[0]
console.log('Patron:')
console.log(' Name: ' + name)
console.log(' Barcode: ' + barcode)
console.log(' Patron Type: ' + pType)To POST a new "TestSchema" schema:
const resp = await client.post('schemas/TestSchema', { name: "TestSchema", type: "record", fields: [ ... ] })
if (resp.data.stream !== 'TestSchema') throw Error('Error creating schema...')A small CLI exists for common tasks.
Set up:
git clone git@github.com:NYPL/node-nypl-data-api-client.git
cd node-nypl-data-api-client
nvm use; npm i
cp .env-example .env
# Fill in missing details in .env
To fetch the first 25 bibs:
./bin/nypl-data-api.js get bibsTo fetch a specific bib:
./bin/nypl-data-api.js get bibs/sierra-nypl/11040445To create a hold-request:
./bin/nypl-data-api.js post hold-requests '{ "record": "1234", "patron": ... }'To specify a different .env, use the --envfile param (e.g. --envfile .env-qa)
A special schema command is provided for updating schemas. To post a new schema, run the following to upload the content of the given jsonfile to schemas/[name]
./bin/nypl-data-api.js schema post [name] [jsonfile]- Cut feature branchs from
main - After review, merge to
main - Bump version in
package.json& note changes inCHANGELOG.md git tag -a v[version]npm publish
npm test