SSIS tutorial: How to extract data from DocuWare using REST API

Introduction

DocuWare is a powerful document management platform that provides REST APIs for accessing documents, metadata, and workflows. This guide demonstrates how to connect Zappysys SSIS connectors to DocuWare using OAuth 2.0 or Bearer Token authentication.

Whether you are using DocuWare Cloud or an on-premises deployment, you will learn how to configure secure authentication without writing any custom code. Zappysys handles all the technical complexity, allowing you to focus on building your ETL workflows.

Prerequisites

1. SQL Server Integration Services (SSIS) must be installed.
2. Visual Studio with SSIS extension or SQL Server Data Tools (SSDT) is required.
3. Active DocuWare account with appropriate permissions.
4. ZappySys SSIS PowerPack installed.

Steps

Get the Endpoint Examples

Download the DocuWare API Postman collection to review available endpoints. This helps you understand the API structure before configuring your connection. For additional guidance, see our article on migrating Postman to SSIS.

OAuth 2.0 Connection (DocuWare Cloud)

1. Create or select your SSIS project and open the package.dtsx file.
2. Drag and drop the ZS REST API task from the Toolbox.
3. Right-click in the Connection Managers pane and select New Connection…
4. Select ZS-OAuth from the SSIS connectors list.
   

   Create a new SSIS OAuth API Connection Manager

5. Set the OAuth Version to OAuth 2.0.
6. Set Grant Type to Password Grant.
7. Enter Client ID: docuware.public.client
8. Enter your DocuWare credentials (username and password).
9. Enter the Token URL:
   
   https://your-docuware-server/DocuWare/Platform/Account/Logon

   1	https://your-docuware-server/DocuWare/Platform/Account/Logon

10. Enter the Scope: docuware.platforms
11. Click OK to save the connection.
    

    Docuware – OAuth connection

NTLM Authentication (For On-Premises or Windows-based Environments)

1. If using NTLM authentication instead of OAuth, select ZS-HTTP from the SSIS connectors list.
2. Set Credential Type to NTLM Authentication.
3. Enter the Base URL:
   
   https://your-docuware-server/DocuWare/Platform

   1	https://your-docuware-server/DocuWare/Platform

4. Enter your Windows credentials (domain\username and password).
5. Click OK to save the connection.
   

   Docuware – NTLM Authentication connection

Configure the REST API Task

1. Drag and drop the REST API task into the Control Flow, then double-click it to open the editor.
2. Select the connection you created (OAuth or NTLM).
3. Enter the DocuWare API endpoint URL (for example: /FileCabinets to retrieve all file cabinets and document trays)
4. Select the appropriate HTTP method—typically GET for retrieving data.
5. Click Test Connection to verify the configuration works correctly.
   

   Docuware – REST API example

Conclusion

You now have a secure and reliable connection between Zappysys SSIS and DocuWare. Use OAuth 2.0 for DocuWare Cloud deployments and NTLM authentication for on-premises environments.

With your connection configured, you can build powerful ETL workflows using the REST connector in SSIS to extract document data, apply transformations, and load results into SQL Server—all without writing any custom code.

Next steps: Create a Data Flow Task and use the Zappysys REST Source component to query DocuWare API endpoints and load the extracted document data into your SQL Server database.

Need Help?

If you have questions or encounter any issues:

1. Live Chat Support — Use the chat widget on this page for immediate assistance
2. Email Support — support@zappysys.com
3. DocuWare Support Portal — Visit https://www.docuware.com/en/support