No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.

Node.js SDK for Yumpu

Build Status npm version

With Node.js SDK you can create effective Node.js tools to publish your pdf documents on your Node application. Find out how to get started, publish your first pdf as flip book on the web or use the search function to display content.


What is a Node.js SDK? To make it simple, SDK defines a set of functions which developers can use to perform requests and receive data from the REST API.

Common characteristics of Yumpu REST API resources are as follows:

  1. You access the resource by sending an HTTP request to the API server. The server replies with a response that contains either the data you requested, or the status indicator, or even both.
  2. All resources are located at
  3. All resources may return different HTTP status codes (e.g., HTTP Status Code 200 for success response or HTTP Status Code 400 for the bad request).
  4. You request a particular resource by adding a particular path to the base URL that specifies the resource.

Get started

Install the yumpu package from npm:

$ npm install yumpu


// initialize the yumpu class
var yumpu = require('yumpu');

// set your token (find your token:

// example to get all your documents:

// set parameters
var parameters = {
  limit: 10,
  offset: 0

// function getDocuments()
yumpu.getDocuments(parameters, function(statusCode, document) {
  console.log('STATUS: ' + statusCode);


[i]-magazine AG
Web-based, self-service (SaaS) marketing & magazine software

Tel: +49 (0)89 41 61 70 20

Moosackerstraße 17
9444 Diepoldsau, SG – Schweiz
Firmenbuch-Nr: CH-320.1.081.510
Mwst. Nummer: CHE-113.772.377