lasselehtinen/woodwing-assets

API wrapper for WoodWing Assets

v1.1 2024-03-20 07:34 UTC

This package is auto-updated.

Last update: 2024-10-30 00:26:10 UTC


README

API wrapper for WoodWing Assets

Latest Version on Packagist Run tests Total Downloads

Package for doing REST API queries against Woodwings Elvis DAM (Digital Asset Management).

Installation

You can install the package via composer:

composer require lasselehtinen/woodwing-assets

You can publish the config file with:

php artisan vendor:publish --tag="woodwing-assets-config"

This is the contents of the published config file:

<?php

return [

    /*
    |--------------------------------------------------------------------------
    | WoodWing Assets configuration
    |--------------------------------------------------------------------------
    |
    | Note! Remember to include the full API endpoint to the hostname
    |
     */

    'endpoint' => env('WOODWING_ASSETS_ENDPOINT', 'https://assets.example.com/services'),
    'username' => env('WOODWING_ASSETS_USERNAME', 'guest'),
    'password' => env('WOODWING_ASSETS_PASSWORD', 'guest'),
];

Usage

$assets = new \LasseLehtinen\Assets\Assets();
$searchResults = $assets->search(query: 'Jari Tervo', num: 2);

Testing

composer test

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

License

The MIT License (MIT). Please see License File for more information.