Download the PHP package codebar-ag/laravel-docuware without Composer

This package was developed to give you a quick start to communicate with the DocuWare REST API. It is used to query the most common endpoints.

⚠️ This package is not designed as a replacement of the official DocuWare REST API. See the documentation if you need further functionality. ⚠️

Navigation

• Navigation
• 💡 What is DocuWare?
• 🛠 Requirements
• ⚙️ Installation
• 🏗 Usage
  • Getting Started with OAuth
  • Getting a new token via Username & Password:
  • Getting a new token via Username & Password (Trusted User):
  • Available Requests
    • Organization
    • Get Organization
    • Get All File Cabinets And Document Trays
    • User Management
    • Get Users
      • Get Users
      • Get User By Id
      • Get Users Of A Role
      • Get Users Of A Group
    • Create/Update Users
      • Create User
      • Update User
    • Get/Modify Groups
      • Get Groups
      • Get All Groups For A Specific User
      • Add User To A Group
      • Remove User From A Group
    • Get/Modify Roles
      • Get Roles
      • Get All Roles For A Specific User
      • Add User To A Role
      • Remove User From A Role
    • File Cabinets
    • General
      • Get File Cabinet Information
      • Get Total Number Of Documents
    • Dialogs
      • Get All Dialogs
      • Get Dialogs of a Specific Type
      • Get Dialogs Of A Specific Type
    • Search
      • Get A Specific Document From A File Cabinet
      • Get Documents From A File Cabinet
      • Most basic example to search for documents.
      • Search in multiple file cabinets
      • Find results on the next page
      • Define the number of results which should be shown per page
      • Use the full-text search
      • Search documents which are created from the first of march.
      • Search documents which are created until the first of april.
      • Order the results by field name.
      • Search documents filtered to the value.
      • Search documents filtered to multiple values.
      • You can specify the dialog which should be used.
      • You can also combine everything.
    • Check In Check Out
    • Select Lists
      • Get Select Lists
    • Upload
      • Create Data Record
      • Create Table Data Record
      • Append File(s) To A Data Record
      • Append A Single PDF To A Document
      • Replace A PDF Document Section
      • Batch Index Fields Update
      • Get Fields
    • Documents
    • Update Index Values
      • Update Table Data Record
    • Modify Documents
      • Transfer Document
      • Delete Documents
    • Clip/Unclip & Staple/Unstaple
      • Clip
      • Unclip
      • Staple
      • Unstaple
    • Annotations/Stamps
      • Documents Trash Bin
      • Get Documents
      • Delete Documents
      • Restore Documents
    • Application Properties
      • Add Application Properties
      • Update Application Properties
      • Delete Application Properties
      • Get Application Properties
    • Sections
      • Get All Sections
      • Get Specific Section
      • Delete Section
      • Get Textshot
    • Download
      • Download Document
      • Download Section
      • Download Thumbnail
    • Workflow
    • Workflow History
      • Get Document Workflow History
      • Get Document Workflow History Steps
• Extending the connector (EXAMPLE)
  • Create a new connector
  • Use the new connector
• 🖼 Make encrypted URLs
  • Make encrypted URL for a document in a file cabinet.
  • Make encrypted URL for a document in a basket.
  • Make encrypted URL valid for a specific amount of time.
• 🏋️ Document Index Fields DTO showcase
• 📦 Caching requests
  • Is Cached
  • Invalidate Cache
  • Disable Caching
• 💥 Exceptions explained
• ✨ Events
• 🔧 Configuration file
• 🚧 Testing
• 📝 Changelog
• ✏️ Contributing
• 🧑‍💻 Security Vulnerabilities
• 🙏 Credits
• 🎭 License

💡 What is DocuWare?

DocuWare provides cloud document management and workflow automation software that enables you to digitize, secure and work with business documents, then optimize the processes that power the core of your business.

🛠 Requirements

⚙️ Installation

You can install the package via composer:

Add the following environment variables to your .env file:

With the passphrase we are able to encrypt the URLs.

⚠️ You need to escape backslashes in your passphrase with another backslash:

🏗 Usage

Getting Started with OAuth

This package automatically handles the generation of OAuth token for you and stores them in cache.

Getting a new token via Username & Password:

Getting a new token via Username & Password (Trusted User):

Available Requests

• General
  • Organisation
  • User Management
  • Get Users
  • Create/Update Users
  • Get/Modify Groups
  • Get/Modify Roles
• File Cabinets
  • General
  • Dialogs
  • Search
  • Check/In & Check/Out
  • Select Lists
  • Upload
  • Batch Index Fields Update
• Documents
  • Update Index Values
  • Modify Documents
  • Clip/Unclip & Staple/Unstaple
  • Annotations & Stamps
  • Documents Trash Bin
  • Application Properties
  • Sections
  • Download
• Workflow

Organization

Get Organization

Get All File Cabinets And Document Trays

User Management

Get Users

Get Users

Get User By Id

Get Users Of A Role

Get Users Of A Group

Create/Update Users

Create User

Update User

Get/Modify Groups

Get Groups

Get All Groups For A Specific User

Add User To A Group

Remove User From A Group

Get/Modify Roles

Get Roles

Get All Roles For A Specific User

Add User To A Role

Remove User From A Role

File Cabinets

General

Get File Cabinet Information

Get Total Number Of Documents

Dialogs

Get All Dialogs

Get Dialogs of a Specific Type

Get Dialogs Of A Specific Type

Search

Get A Specific Document From A File Cabinet

Get Documents From A File Cabinet

Most basic example to search for documents.

You only need to provide a valid file cabinet id.

Search in multiple file cabinets

Provide an array of file cabinet ids.

Find results on the next page

Default: 1

Define the number of results which should be shown per page

Default: 50

Use the full-text search

You have to activate full-text search in your file cabinet before you can use this feature.

Search documents which are created from the first of march.

Search documents which are created until the first of april.

Order the results by field name.

Supported values: 'asc', 'desc'

Search documents filtered to the value.

You can specify multiple filters.

Search documents filtered to multiple values.

You can specify the dialog which should be used.

You can also combine everything.

Check In Check Out

Not Currently Supported

Select Lists

Get Select Lists

Upload

Create Data Record

Create Table Data Record

Append File(s) To A Data Record

Append A Single PDF To A Document

Replace A PDF Document Section

Batch Index Fields Update

Not Currently Supported

Get Fields

Documents

Update Index Values

Update Table Data Record

Modify Documents

Transfer Document

Delete Documents

Clip/Unclip & Staple/Unstaple

Clip

Unclip

Staple

Unstaple

Annotations/Stamps

Not Currently Supported

Documents Trash Bin

Get Documents

You can use the same methods as in the search usage. The only difference is that you have to use the trashBin method after the searchRequestBuilder method. php use CodebarAg\DocuWare\DocuWare;

$paginatorRequest = (new DocuWare()) ->searchRequestBuilder() ->trashBin() bash php artisan vendor:publish --provider="CodebarAg\DocuWare\DocuWareServiceProvider" --tag="docuware-config" bash cp phpunit.xml.dist phpunit.xml xml

## 📝 Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## ✏️ Contributing

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

## 🧑‍💻 Security Vulnerabilities

Please review [our security policy](.github/SECURITY.md) on how to report security vulnerabilities.

## 🙏 Credits

- [Sebastian Fix](https://github.com/StanBarrows)
- [Rhys Lees](https://github.com/RhysLees)
- [All Contributors](../../contributors)
- [Skeleton Repository from Spatie](https://github.com/spatie/package-skeleton-laravel)
- [Laravel Package Training from Spatie](https://spatie.be/videos/laravel-package-training)

## 🎭 License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.