Package Exports
- @preprio/nodejs-sdk
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@preprio/nodejs-sdk) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Node.js Prepr Content Delivery SDK
- Source code on GitHub.
About Prepr
Hi there, nice to meet you. We are Prepr, and we are the world’s first data-driven headless content management system. With just one solution, we offer you all the tools you need to publish impactful content.
Getting started
Installation
Get started by installing the SDK in your application, simply open a terminal and enter
npm i @preprio/nodejs-sdk
Creating a client
We don't want to repeat our configuration for every api call, that's why we suggest you create a client from which you make requests. Let's make a client by creating services/prepr.js
with the following code
// services/prepr.js
const { createPreprClient } = require('@preprio/nodejs-sdk')
const prepr = createPreprClient({
token: '<your access token>', // required
timeout: 4000, // default value
baseUrl: 'https://cdn.prepr.io', // default value
userId: null, // optional, used for AB testing
})
module.exports = { prepr }
Great, now we have the configuration in one place. Now, we can import our configured prepr client to perform requests.
Usage
To perform API requests you can make use of our fluent builder, this is how it looks like
// We created this earlier
const { prepr } = require('./services/prepr')
const publications = await prepr
.path('/publications') // request path `https://cdn.prepr.io/publications`
.query('...') // query data https://prepr.dev/docs/rest/v1/introduction
.timeout(8000) // Override globally set timeout for request cancellation
.userId('...') // Override globally set userId for ab testing
.sort('created_at') // Sort data
.limit(8) // Limit the amount collections being returned
.fetch() // Fetch the collections
To help you querying our API we've added multiple examples to our Developers site.
Reach out to us
You have questions about how to use this library or the Prepr API? Contact our support team at support@prepr.io or join our Prepr Slack.
You found a bug or want to propose a feature?
File an issue here on GitHub. Don't share any authentication info in any code before sharing it.