Connect Pimcore to DPPora

How to connect your catalogue

1. Create a read-only Datahub

   In Pimcore Studio, open the four-square menu → Automation & Integration → Data Hub Configuration. Click New and choose GraphQL. Name the configuration and enable General → Active.

2. Choose the fields to export

   Open Schema Definition → Query Schema → Add and select your product class. Click its Settings gear. Expand Class Attributes → Data object columns. Drag across the fields you want to import: product name, SKU, GTIN, description, brand, model, country of origin, content language and image. Include System columns → ID (id). Only product name is required in DPPora; the other mappings are optional. Add only the optional fields you need.

3. Add fields individually

   Drag the first field into the empty Available Fields panel. Drop each following field immediately below the previous one, where an insertion line appears. Do not use Insert all definitions if you want to restrict the exported fields. Click Apply. Leave Mutation Schema empty.

4. Generate the API key

   Open Security Definition and click Generate Key. Keep Skip Permission Check off. Keep the key ready to paste into DPPora; do not include it in your URL.

5. Limit access to your products

   Under Security Definition → Workspaces → Data Objects, click Add. Click the cube near the bottom of the far-left toolbar to open Data Object Tree. Drag your intended product folder into the blank Path cell. Keep Read checked and leave Create, Update and Delete off. Remove broader grants. The folder you allow determines which products DPPora can read.

6. Allow access to images, if needed

   Under Workspaces → Assets, click Add. Click the camera above the cube at the bottom left to open Asset Tree. Drag the folder containing your product images into the blank Path cell. Read is checked automatically; leave all write permissions off. Generic Types read permissions are not needed for images attached to exported products. Click Save.

7. Copy the Datahub URL

   Click Open in tab in your saved configuration. Copy the endpoint shown inside the GraphQL Playground, rather than the Playground page address. Use your publicly reachable HTTPS Pimcore domain and the configuration path, for example https://your-pimcore-domain.com/pimcore-graphql-webservices/your-configuration. Remove any API key from the URL. A localhost address cannot be reached by DPPora.

8. Map and save your product fields

   In DPPora, open Products → Import products → Connect to Pimcore. Open Step 3: Map your product fields. In Pimcore, return to Schema Definition → Query Schema and click the gear beside your product class. The names in brackets are your field names: enter each beside its matching DPPora field. Pimcore field names are defined by your administrator, so they may differ from our examples. Only product name is required; leave other mappings blank if you do not want to import them. For images, enter the field name such as “image” or “photo”; DPPora handles the image path. Click Save field mappings to save them to your account.

9. Connect and test one product

   In Step 4, paste the Pimcore Datahub URL and API key, then click Connect Pimcore. Select one product first and click Import selected products. Check its details and image before importing the full catalogue.

10. Import and review your catalogue

    Select the products you want and click Import selected products. Follow the spinner and product count. When complete, click Open product catalogue to review the results. Products are imported into your organisation’s catalogue; passports are not published automatically.