Dive into the yuuvis® API

The yuuvis® API lets you build new or enhance existing information management / document management solutions. Take the time to familiarize yourself with how the yuuvis® API works and what it can do for you. The "Getting started ..." will get you started. Move on to the "How to ..." section to learn more about each endpoint, read further background information and jump right in to the product.

Getting started ....

The following information provides the foundation for you to work with the yuuvis® API.

  1. How to Sign Up for the Dev Platform ...
  2. Quick Start: API Intro Guide ...
  3. Configuration and Settings endpoints
  4. Core Capabilities (CRUD) endpoints

How to ...

The following descriptions provide an introduction to the yuuvis® API. Learn how to upload documents (objects) into your centralized storage, retrieve and manage them. If you are new to content services and document management systems, please go through them in the order in which they are listed below. This order represents a logical progression in the knowledge of the product.

Please note that we use Java code samples for our "How to ..." descriptions.

  1. Import and Store Documents ... (single / multiple)
  2. Retrieve Documents ... (via ObjectID / search endpoint using query language)
  3. Retrieve the History Entries of a Document ... (structure / retrieving entries / entry types)
  4. Update Documents ... (index data / content / versioning)
  5. Delete Documents ... (document / version / link document / compound document)
  6. Rendition Requests ... (file types)
  7. Schema Definition ... (retrieve, validate and update endpoints / structure)
  8. Glossary ...