API
  • Yumpu documentations
  • JS
    • Introduction
    • Quick setup
    • Magazine example's
    • Bookshelf example's
    • FAQs
  • API
    • Introduction
    • Getting started
      • API token
      • Document API
      • User API
      • Search API
      • Install SDK's
    • Limits
    • Flowchart of basic processes
    • Documents
      • Get
    • Document
      • Get
      • Post file
      • Post url
      • Put
      • Delete
    • Document hotspots
      • Get
    • Document hotspot
      • Get
      • Post
      • Put
      • Delete
    • Document progress
      • Get
    • Document categories
      • Get
    • Document languages
      • Get
    • Countries
      • Get
    • Collections
      • Get
    • Collection
      • Get
      • Post
      • Put
      • Delete
    • Section
      • Get
      • Post
      • Put
      • Delete
    • Section document
      • Post
      • Delete
    • Search
      • Get
    • User
      • Get
      • Post
      • Put
    • Embeds
      • Get
    • Embed
      • Get
      • Post
      • Put
      • Delete
    • Members
      • Get
    • Member
      • Get
      • Post
      • Put
      • Delete
    • Access tags
      • Get
    • Access tag
      • Get
      • Post
      • Put
      • Delete
    • Subscriptions
      • Get
    • Subscription
      • Get
      • Post
      • Put
      • Delete
Powered by GitBook
On this page
  • Document API
  • Upload Document
  • Manage Documents
  • List Documents
  • Organize documents with collections
  • Sections are Subgroups of Collections
  • Add Document to a Section

Was this helpful?

  1. API
  2. Getting started

Document API

PreviousAPI tokenNextUser API

Last updated 3 years ago

Was this helpful?

Document API

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. CALL: DOCUMENT POST FILE CALL: DOCUMENT POST URL CALL: DOCUMENT GET CATEGORIES CALL: DOCUMENT GET LANGUAGES CALL: DOCUMENT GET Render Status

Pull documents you already got inside your account. They can be uploaded and managed both manually and via Data API from any web platform. CALL: DOCUMENT GET CALL: DOCUMENT PUT CALL: DOCUMENT DELETE

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. CALL: DOCUMENTS GET

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. CALL: GET COLLECTION CALL:POST COLLECTION CALL: PUT COLLECTION CALL: DELETE COLLECTION 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. CALL: GET 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. CALL: SECTION GET CALL: SECTION POST CALL: SECTION PUT CALL: SECTION DELETE

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. CALL: SECTION DOCUMENT POST CALL: SECTION DOCUMENT DELETE

Upload Document
Upload Document via file
Upload Document via Url
Get Document Category List
Get Document Language List
Get current Render Status
Manage Documents
Get a single Document
Update Document Data
Delete a Document
List Documents
Load a Document List
Organize documents with collections
List Collection
Create Collection
Update Collection
Delete Collection
List Collections
List all my Collections
Sections are Subgroups of Collections
List Section
Create Section
Update Section
Delete Section
Add Document to a Section
Add Document
Delete Document