Integrate iPaaS.com with Pimcore to enable seamless data synchronization for products, product categories, product variants, and related products.
How to Connect
Pimcore connects to iPaaS.com through the Pimcore Datahub GraphQL API. iPaaS.com reads product data from your Datahub GraphQL endpoint, and Pimcore sends change notifications to iPaaS.com through a Datahub webhook. You provide the connection details from your Pimcore Datahub configuration in the iPaaS.com subscription settings.
Prerequisites
Before configuring the subscription, complete the Pimcore-side setup described in the Pimcore Installation Instructions:
The Pimcore Datahub (GraphQL) bundle is installed and enabled on your Pimcore instance.
A Datahub GraphQL configuration exists that exposes the product and category classes you intend to transfer, including the ID and classname system fields.
A Datahub API key (Security Definition) has been generated with access to the relevant data-object and asset paths.
A Datahub webhook has been configured to notify iPaaS.com of changes (used for automatic transfers).
Configuration Details
Gather these values from your Pimcore Datahub configuration:
API URL: the base GraphQL web-services URL of your Pimcore instance. Example: https://your-pimcore-instance.example.com/pimcore-graphql-webservices
API Key: the API key generated on the Datahub Security Definition tab. Example: 6332aa5e6d3d6c0be31da2a8b3454321
Datahub Config: the name of your Datahub GraphQL configuration. Example: iPaaS-connection
iPaaS.com combines these three values to reach your Datahub GraphQL endpoint, in the form API URL / Datahub Config ? apikey = API Key.
Configure Subscription Settings
Enter the following settings on the iPaaS.com Pimcore subscription. The class-name settings use the Datahub field-naming convention (the full GraphQL path); see the Pimcore to iPaaS.com Product Mapping Documentation for that convention. Values shown are from the Pimcore Cars demo data and are examples only.
Field | Description | Required | Example |
API URL | The base GraphQL web-services URL of your Pimcore instance. | Yes | |
API Key | The Datahub Security Definition API key iPaaS.com uses to query your Datahub endpoint. | Yes | 6332aa5e6d3d6c0be31da2a8b3454321 |
Datahub Config | The name of your Datahub GraphQL configuration. | Yes | iPaaS-connection |
Product Class Names | Comma-separated Pimcore class(es) transferred as iPaaS.com Products. | Conditional | Car |
Product Category Class Names | Comma-separated Pimcore class(es) transferred as iPaaS.com Product Categories. | Conditional | Category |
Product Category Assignment Class Names | The relation field that links a product to its categories (a Many-To-Many Object Relation). | Conditional | Car.categories |
Related Product Class Names | The relation field that holds a product's related products. | Conditional | Car._siblings |
Variant Class Names | The relation or field that holds a product's variants. | Conditional | Car.children |
Variant Parent Field | The path to the id of a variant's parent, used to route a variant webhook to its parent product. | Conditional | Car.parent.[on object_Car].id |
Variant Category Assignment Class Names | The relation field that links a variant to its categories. | Conditional | Car.children.[on object_Car].categories |
Variant Related Product Class Names | The relation field that holds a variant's related products. | Conditional | Car.children.[on object_Car]._siblings |
CDN | An optional content-delivery base used when building image URLs. | No |
Conditional settings are required only when you transfer the corresponding data. To transfer products you must set the connection fields (API URL, API Key, Datahub Config) and Product Class Names; add the category, variant, and related-product settings for the data types you use. Variant Parent Field is required whenever variants are transferred, so that a webhook for a variant is redirected to its parent product.
Note: A Variant Dimension Fields setting may appear in the subscription settings. It is no longer used — variant dimensions are now defined through the variant-option mapping functions described in the mapping documentation — and can be left blank.
Authentication Methods
The integration authenticates to Pimcore with the Datahub API Key. iPaaS.com sends this key as a query-string parameter when it queries your Datahub GraphQL endpoint, so no separate login or token exchange is required. Keep the API key's Datahub Security Definition scoped to the data-object and asset paths the integration needs.
For automatic transfers, Pimcore authenticates to iPaaS.com using your iPaaS.com subscription webhook key, which is placed in the Pimcore Datahub webhook subscriber URL as a key query-string parameter. See the Pimcore Installation Instructions for how to build that webhook URL.
Initialization Support
Bulk initialization is not supported for this integration. To load existing Pimcore data into iPaaS.com, use a scheduled poll or a Manual Sync (see the mapping documentation for polling filters); to keep data current, configure the Datahub webhook so changes transfer automatically.
Throttling
The subscription's throttling settings control how many requests the integration runs concurrently and how quickly it retries. These fields are pre-populated with default values on the subscription settings page and can be adjusted for your volume. See the Subscription Configuration – Edit Help Center article for a full description of the throttle limit, throttle seconds, and concurrency settings.