README

Import/export and REST API for OpenDXP — exchange data between external sources and OpenDXP objects, assets, and documents without writing code.

Sylphen Data Bridge is an OpenDXP bundle by Sylphen GmbH & Co. KG, based on Blackbit Data Director 3.10.4, adapted for OpenDXP 1.3+.

Features

Dataports — import/export of XML, CSV, JSON, Excel, and other formats
Field mapping — visual mapping from source to target fields
REST API — import, export, and status via /api/rest/… (or /webservice/SylphenDataBridge/rest/…)
Queue & cron — automated, parallel processing of large datasets
OpenDXP integration — backend menu, custom field types, custom reports, perspectives

Requirements

PHP ≥ 8.3
OpenDXP ≥ 1.3 (open-dxp/opendxp, open-dxp/admin-bundle)
Composer 2.x

Installation

From Packagist (recommended)

composer require sylphen/opendxp-data-bridge:^1.0
bin/console opendxp:bundle:install SylphenDataBridgeBundle
bin/console assets:install --symlink --relative

The bundle registers automatically via extra.opendxp.bundles in the package composer.json. Or manually in config/bundles.php:

Sylphen\DataBridgeBundle\SylphenDataBridgeBundle::class => ['all' => true],

Maintainers: docs/PACKAGIST.md.

From GitHub (VCS)

In an existing OpenDXP project:

"repositories": [
  {
    "type": "vcs",
    "url": "https://github.com/sylphen-systemhaus/opendxp-data-bridge.git"
  }
],
"require": {
  "sylphen/opendxp-data-bridge": "^1.0"
}

composer require sylphen/opendxp-data-bridge:^1.0
bin/console opendxp:bundle:install SylphenDataBridgeBundle
bin/console assets:install --symlink --relative

To test unreleased commits on main, use "dev-main" instead — not for production.

Docker demo (try-out)

Isolated OpenDXP + Data Bridge on http://localhost:2000/admin (admin / admin). Requires Docker Compose v2 and network access (Composer).

git clone https://github.com/sylphen-systemhaus/opendxp-data-bridge.git
cd opendxp-data-bridge
chmod +x docker-setup.sh
./docker-setup.sh

The checkout is mounted as a Composer path repo — edits are visible immediately.

Development (submodule or path repo)

For day-to-day bundle work in an OpenDXP project, use a submodule + path repository (not @dev from Packagist). See docs/DEVELOPMENT.md.

From artifact ZIP (offline)

If you received a vendor ZIP, place it in bundles/ and add to the project composer.json (OpenDXP root):

"repositories": [
  {
    "type": "artifact",
    "url": "./bundles/"
  }
],
"require": {
  "sylphen/opendxp-data-bridge": "*"
}

composer update sylphen/opendxp-data-bridge
bin/console opendxp:bundle:install SylphenDataBridgeBundle
bin/console assets:install --symlink --relative

REST API

Canonical endpoints (API key required):

POST /api/rest/import/{dataportId}?apikey=…
GET  /api/rest/export/{dataportId}?apikey=…
GET  /api/rest/status?…

Alternative webservice schema (same controllers):

POST /webservice/SylphenDataBridge/rest/import/{dataportId}?apikey=…

Blackbit URL segments (BlackbitDataDirector, BlackbitPim, …) are not supported. See SECURITY.md.

Documentation & examples

docs/DEVELOPMENT.md — integrate into an OpenDXP project (submodule, path repo, @dev)
docs/PACKAGIST.md — tagged releases and Packagist (maintainers)
docs/UPGRADE.md — migrate from Blackbit Data Director 3.10.4; leftover data_director_* indexes
Feature handbook (original Blackbit, including Data Query Selectors): Data Director Docs
Tutorial videos: YouTube playlist
Sample data: examples/ — Blackbit-origin reference; see examples/README.md

Contributing

See CONTRIBUTING.md. Security reports: SECURITY.md — no public issues for vulnerabilities.

License

This bundle is licensed under the GNU General Public License v3.0 or later (SPDX: GPL-3.0-or-later). Additional attribution and bundled dependencies: NOTICE.

sylphen / opendxp-data-bridge

Maintainers

Package info

Statistics

Security