Postman collections

For a quick start with our REST API you can download one of our available Postman Collections here:

*Requires DocuWare 7.11+

What is Postman?

It's an API documentation/testing tool.
All information about this tool can be found at https://www.getpostman.com

Where to get it?

https://www.getpostman.com/downloads/

How it works?

https://learning.getpostman.com

Quick start

https://learning.getpostman.com/docs/postman/launching_postman/sending_the_first_request

Working with collections

  1. Open Postman
  2. Click on import (upper left corner)
  3. Choose a sample collection. IE. DocuWare_REST_Samples.postman_collection.json
  4. It should appear on the left part of the postman screen, if not go to "view - toggle sidebar"

The DocuWare Postman collections

The DocuWare Postman collections are split into two separate collections.

  • Main DocuWare API
    • This collection contains sample requests for basic DocuWare functionality. This includes authentication, storing documents, searching for documents, and updating documents.
  • App Registration API
    • This collection contains requests related to the App Registration API. It covers authenticating with DocuWare so requests can be made to the App Registration API, as well as examples of creating, deleting and updating registrations.

Each sample collection contains an associated environment that should be imported, and configured according to the documentation that is included with each collection.

Handle culture and language cookies

If you want to specify an exact culture or language you are able to use our cookies for that.
For culture DWFormatCulture and for language DWLanguage it is.

Add these in Postman as follows:
First open some request like Forms Authentication and click on Cookies.

Then select your connection and click add cookie.

Note

If there is no correct connection area for selection, first authenticate with the server.
You'll then receive an connection area for this server.

After that enter the correct values and click save.

Note

The value is based on RFC 4646 languagecode2(ISO 639-1)-country/regioncode2(ISO 3166-2) for culture and only the DocuWare supported languages will work!

Note

The value is in languagecode2(ISO 639-1) for language and only the DocuWare supported languages will work!

Any problems?

In case of trouble or questions, contact our support:
DocuWare Support