Build powerful publishing tools!

Media companies, hotels or engineering businesses are using Yumpu to convert their documents from huge pdf documents to web optimized e-Papers. Offering one of the most powerful document publishing APIs, Yumpu gives to the tools you need to create documents and market them to your readers on the internet, mobile or via native tablet apps. Yumpu supports web standards and offers a whole load of features: upload, convert and host documents, present the documents using the html5 or flashview.

With Yumpu.com API you can create effective tools to publish your pdf documents on your website, tablet or mobile application. Find out how to get started, publish your first pdf as flip book on the web or use the search api to display content.

Yumpu.com is FREE and offers additional premium features .
Learn more

Get Started with the API

Introduction to Yumpu API
Getting started right now
Flowchart of Processes
Technical Limits

 

001_Yumpu_Robots_white-01

Document API

Upload Document

To get started using Yumpu you need a user and then can start uploading documents using the API. The Document Upload API gives you the possibility to create, edit and display your documents. Using Yumpu you can then select from several Players for desktop and mobile devices.

Upload Document via file
CALL: DOCUMENT POST FILE
Upload Document via Url
CALL: DOCUMENT POST URL
Get Document Category List
CALL: DOCUMENT GET CATEGORIES
Get Document Language List
CALL: DOCUMENT GET LANGUAGES
Get current Render Status
CALL: DOCUMENT GET Render Status

Manage Documents

Pull documents you already got inside your account. They can be uploaded and managed both manually and via Data API from any webplatform.

Get a single Document
CALL: DOCUMENT GET
Update Document Data
CALL: DOCUMENT PUT
Delete a Document
CALL: DOCUMENT DELETE

List Documents

Get an overview of documents that are stored in your account. Use this command as a basis for other requests to manage, display or modify your documents.

Load a Document List
CALL: DOCUMENTS GET

Organize documents with collections

Collections are used to hold Sections for your APP or WEBKiosk. Collections are like Folders and can hold Subfolders, or Sections how we call them. Sections in turn then can hold Documents.

List Collection
CALL: GET COLLECTION
Create Collection
CALL:POST COLLECTION
Update Collection

CALL: PUT COLLECTION
Delete Collection
CALL: DELETE COLLECTION

List Collections
Listing all Collections gives an overview of all collections that have been ceated so far. This gives you quickly a good overview of the existing Folders and allows you to create subfolders, or Sections from there.

List all my Collections
CALL: GET COLLECTIONS

Sections are Subgroups of Collections

Sections are used to organize Documents. They are like Subfolders and can hold documents. Sections always need to sit inside a collection and can be pulled in formats json and xml. You can get this in data-format, or you can directly use it for your WEBKiosk or APPKiosk.

List Section
CALL: SECTION GET
Create Section
CALL: SECTION POST
Update Section
CALL: SECTION PUT
Delete Section
CALL: SECTION DELETE

Add Document to a Section

Using the Section document command allows to add documents to these Subfolders. This helps you organize and later pull several documents in a sorted form. You can get this data as json or xml list, or you can directly use it for your WEBKiosk or APPKiosk.

Add Document
CALL: SECTION DOCUMENT POST
Delete Document
CALL: SECTION DOCUMENT DELETE

Manage User details

Using the User Commands allows to create new Users, read and add details. If your application requires to have several different groups or needs to display content structured by users, creating and managing useraccounts via yumpu api allows you to do that.

Read my Userdetails
CALL: USER GET
Create a new User:
CALL: USER POST
Update my Userdetails
CALL: USER PUT
Get Country List
CALL: GET COUNTRIES

Search API

The Search API allows you to pull Content from Yumpu and Enhance your existing Website, Application or APP using Rich-Media Publications from Yumpu.com. From Tourguides to Technical instructions, Yumpu offers a broad range of Content allowing you to improve userexperience for your users.

Search Documents using the Search API
CALL: SEARCH GET