bo-hub/ci-hub-api-bundle

REST Adapter for CI-HUB

3.0.21 2024-06-16 08:21 UTC

Requires

• php: ^8.2 || ^8.3
• elasticsearch/elasticsearch: ^7.0 || ^8.9
• handcraftedinthealps/elasticsearch-dsl: ^8.0
• league/flysystem-bundle: ^3.2
• nelmio/api-doc-bundle: ^4.12
• pimcore/admin-ui-classic-bundle: ^1.4.0
• pimcore/data-hub: ^1.7.0
• pimcore/elasticsearch-client: ^1.0
• symfony/messenger: ^5.0 || ^6.0 || ^7.0
• webmozart/assert: ^1.11
• zircote/swagger-php: ^3.0 || ^4.7

Requires (Dev)

• codeception/codeception: ^5.0
• codeception/module-symfony: ^3.1
• codeception/module-webdriver: ^4.0.0
• dg/bypass-finals: ^1.5
• friendsofphp/php-cs-fixer: ^3.28
• mockery/mockery: ^1.6
• phpstan/phpstan: ^1.10
• phpstan/phpstan-symfony: ^1.3
• phpunit/phpunit: ^10.3
• phpunitgen/console: ^5.0
• rector/rector: ^1.0.2
• symfony/phpunit-bridge: *
• symplify/easy-coding-standard: ^9.0

Replaces

• ci-hub/simple-rest-adapter-bundle: *

GPL-3.0-or-later

• CI HUB GmbH
• Brand Oriented
• Dominik Labudzinski

• pimcore
• pimcore-bundle

README

This bundle adds a REST API endpoints to Pimcore DataHub for Assets and DataObjects. All exposed data can be configured, is indexed in Elasticsearch and delivered from there for better query performance and scalability.

Therefore, it can be used to connect Pimcore to other systems or to connect Front-End applications.

Support

We are the owner of The Pimcore Connector Bundle due to our commitment to the Open Source community and the amazing users of Pimcore Systems around the world. An as any OpenSource Project the support if provided by the community for free.

Here is the GitHub Community Board if you like to collaborate with the community on how to improve or enhance the Pimcore Connector Bundle.

In addition, if you consider commercial Pimcore Implementation we are ready to help with Implementation and adapting it to your Corporate needs. We do offer commercial support as BrandOriented for specific commercial Pimcore implementations. To get more details about the process and maybe involved cost, please contact us: [e-mail], https://pimcore.effiana.com.

So you can choose what works best for you.

Features in a nutshell

• Configure a schema and expose data like with other DataHub adapters via Drag & Drop.
• All data gets indexed in Elasticsearch indices and delivered from there (no additional load on the database when accessing data via REST endpoints).
• Endpoint documentation and test via Swagger UI.
• Available endpoints:
  • tree-items: Method to load all elements of a tree level with additional support for:
    • paging
    • filtering
    • fulltext search
    • ordering
    • aggregations – provide possible values for fields to create filters
  • search: Method to search for elements, returns elements of all types (no folder structures) with additional support for:
    • paging
    • filtering
    • fulltext search
    • ordering
    • aggregations – provide possible values for fields to create filters
  • get-element: Method to get one single element by type and ID.
  • add-asset: Method to create and replace asset
  • download-asset: Method to download binary file
  • lock-asset: Method to lock asset by current user
  • unlock-asset: Method to unlock asset by current user
• Endpoint security via bearer token that has to be sent as header with every request.

Further Information

• Installation & Bundle Configuration
• User authorization
• Endpoint Configuration Details
• Indexing Details
• CI HUB Connector Configuration
• Development

License

Brand Oriented, Okopowa 33/26, 01-059 Warszawa, Polska
brandoriented.pl, [e-mail]
Copyright © 2023 Brand Oriented. All rights reserved.

CI HUB GmbH, Benkertstrasse 4, 14467 Potsdam, Germany
ci-hub.com, [e-mail]
Copyright © 2021 CI HUB GmbH. All rights reserved.

For licensing details please visit LICENSE.md