Download the PHP package codebar-ag/laravel-docuware without Composer
On this page you can find all versions of the php package codebar-ag/laravel-docuware. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download codebar-ag/laravel-docuware
More information about codebar-ag/laravel-docuware
Files in codebar-ag/laravel-docuware
Package laravel-docuware
Short Description DocuWare integration with Laravel
License MIT
Homepage https://github.com/codebar-ag/laravel-docuware
Informations about the package laravel-docuware
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
- 💡 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
- Extending the connector (EXAMPLE)
- Create a new connector
- Use the new connector
- 🖼 Make encrypted URLs
- 🏋️ Document Index Fields DTO showcase
- 📦 Caching requests
- 💥 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
Version Support
| Version | PHP Version | Laravel Version | DocuWare Cloud Access | |-----------------|-------------|-----------------|-----------------------| | > v11.0 (alpha) | ^8.2 | ^11.* | ✅ | | > v4.0 | ^8.2 | ^11.* | ✅ | | > v3.0 | ^8.2 | ^10.* | ✅ | | > v2.0 | ^8.1 | ^9.* | ✅ | | > v1.2 | ^8.1 | ^9.* | ✅ | | < v1.2 | ^8.0 | ^8.* | ✅ |Current Support
| Group | Request | Supported | TODO | |-------------------------------------|-------------------------------------------------------------|-----------|------| | Authentication/OAuth | 1. Get Responsible Identity Service | ✅ | | | Authentication/OAuth | 2. Get Identity Service Configuration | ✅ | | | Authentication/OAuth | 3.a Request Token w/ Username & Password | ✅ | | | Authentication/OAuth | 3.b Request Token w/ a DocuWare Token | 🕣 | | | Authentication/OAuth | 3.c Request Token w/ Username & Password (Trusted User) | 🕣 | | | Authentication/OAuth | 3.d.1 Obtain Windows Authorization (On Premises Only) | 🕣 | | | Authentication/OAuth | 3.d.2 Request Token /w a Windows Account (On Premises Only) | 🕣 | | | General/Organisation | Get Login Token | ✅ | | | General/Organisation | Get Organization | ✅ | | | General/Organisation | Get All File Cabinets and Document Trays | ✅ | | | General/UserManagement | Get Users by ID | ✅ | | | General/UserManagement | Get Users of a Role | ✅ | | | General/UserManagement | Get Users of a Group | ✅ | | | General/UserManagement | Create User | ✅ | | | General/UserManagement | Update User | ✅ | | | General/UserManagement | Get Groups | ✅ | | | General/UserManagement | Get All Groups for a Specific User | ✅ | | | General/UserManagement | Add User to a Group | ✅ | | | General/UserManagement | Remove User from a Group | ✅ | | | General/UserManagement | Get Roles | ✅ | | | General/UserManagement | Get All Roles for a Specific User | ✅ | | | General/UserManagement | Add User to a Role | ✅ | | | General/UserManagement | Remove User from a Role | ✅ | | | FileCabinets/General | Get File Cabinet Information | ✅ | | | FileCabinets/General | Get Total Number of Documents | ✅ | | | FileCabinets/Dialogs | Get All Dialogs | ✅ | | | FileCabinets/Dialogs | Get a Specific Dialog | ✅ | | | FileCabinets/Dialogs | Get Dialogs of a Specific Type | ✅ | | | FileCabinets/Search | Get Documents from a File Cabinet | ✅ | | | FileCabinets/Search | Get a Specific Document From a File Cabinet | ✅ | | | FileCabinets/Search | Search for Documents in a Single File Cabinet | ✅ | | | FileCabinets/Search | Search for Documents in Multiple File Cabinets | ✅ | | | FileCabinets/CheckInCheckOut | Check-out & Download a Document | 🕣 | | | FileCabinets/CheckInCheckOut | Check-in a Document from the File System | 🕣 | | | FileCabinets/CheckInCheckOut | Undo Check-out | 🕣 | | | FileCabinets/SelectLists | Get Select Lists & Get Filtered Select Lists | ✅ | | | FileCabinets/Upload | Create Data Record | ✅ | | | FileCabinets/Upload | Append File(s) to a Data Record | ✅ | | | FileCabinets/Upload | Upload a Single File for a Data Record | ❌ | - | | FileCabinets/Upload | Create a Data Record & Upload File | ❌ | - | | FileCabinets/Upload | Create Data Record & Upload File Using Store Dialog | ❌ | - | | FileCabinets/Upload | Append a Single PDF to a Document | ❌ | - | | FileCabinets/Upload | Replace a PDF Document Section | ❌ | - | | FileCabinets/BatchIndexFieldsUpdate | Batch Update Index Fields By Id | ❌ | - | | FileCabinets/BatchIndexFieldsUpdate | Batch Update Index Fields By Search | ❌ | - | | FileCabinets/BatchIndexFieldsUpdate | Batch Append/Update Keyword Fields By Id | ❌ | - | | Documents/UpdateIndexValues | Update Index Values | ✅ | | | Documents/UpdateIndexValues | Update Table Field Values | ❌ | - ? | | Documents/ModifyDocuments | Transfer Document | ✅ | | | Documents/ModifyDocuments | Delete Document | ✅ | | | Documents/ClipUnclip&StapleUnstaple | Clip | ✅ | | | Documents/ClipUnclip&StapleUnstaple | Unclip | ✅ | | | Documents/ClipUnclip&StapleUnstaple | Staple | ✅ | | | Documents/ClipUnclip&StapleUnstaple | Unstaple | ✅ | | | Documents/AnnotationsStamps | AddStampWithPosition | 🕣 | | | Documents/AnnotationsStamps | AddStampWithBestPosition | 🕣 | | | Documents/AnnotationsStamps | AddTextAnnotation | 🕣 | | | Documents/AnnotationsStamps | AddRectEntryAnnotation | 🕣 | | | Documents/AnnotationsStamps | AddLineEntryAnnotation | 🕣 | | | Documents/AnnotationsStamps | AddPolyLineEntryAnnotation | ❌ | - | | Documents/AnnotationsStamps | DeleteAnnotation | ❌ | - | | Documents/AnnotationsStamps | UpdateTextAnnotation | 🕣 | | | Documents/AnnotationsStamps | Get Stamps | ❌ | - | | Documents/DocumentsTrashBin | Get Documents | ✅ | | | Documents/DocumentsTrashBin | Delete Documents | ✅ | | | Documents/DocumentsTrashBin | Restore Documents | ✅ | | | Documents/ApplicationProperties | Get Application Properties | ✅ | | | Documents/ApplicationProperties | Add Application Properties | ✅ | | | Documents/ApplicationProperties | Delete Application Properties | ✅ | | | Documents/ApplicationProperties | Update Application Properties | ✅ | | | Documents/Sections | Get All Sections from a Document | ✅ | | | Documents/Sections | Get a Specific Section | ✅ | | | Documents/Sections | Delete Section | ✅ | | | Documents/Sections/Textshot | Get Textshot for a Specific Section | ✅ | | | Documents/Download | Download Document | ✅ | | | Documents/Download | Download Section | ✅ | | | Documents/Download | Download Thumbnail | ✅ | | | Workflow | Get Document Workflow History | ✅ | | | Workflow | Get Document Workflow History Steps | ✅ | |⚙️ 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
Extending the connector (EXAMPLE)
We understand it may be repetitive to pass the configuration every time you create a new connector.
You can extend the connector and set the configuration once.
Create a new connector
Use the new connector
🖼 Make encrypted URLs
- Encrypted URLs
🏋️ Document Index Fields DTO showcase
- Document Index Fields DTO
📦 Caching requests
- Caching Requests
💥 Exceptions explained
- Exceptions
✨ Events
The Following events will be fired:
🔧 Configuration file
You can publish the config file with:
This is the contents of the published config file:
🚧 Testing
Copy your own phpunit.xml-file.
Modify environment variables in the phpunit.xml-file:
Run the tests:
📝 Changelog
Please see CHANGELOG for more information on what has changed recently.
✏️ Contributing
Please see CONTRIBUTING for details.
🧑💻 Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
🙏 Credits
- Sebastian Fix
- Rhys Lees
- All Contributors
- Skeleton Repository from Spatie
- Laravel Package Training from Spatie
🎭 License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-docuware with dependencies
guzzlehttp/guzzle Version ^7.8
illuminate/contracts Version ^11.0
nesbot/carbon Version ^2.72
saloonphp/cache-plugin Version ^3.0
saloonphp/laravel-plugin Version ^3.5
saloonphp/saloon Version ^3.7
spatie/laravel-package-tools Version ^1.16