Documentation >
Product catalog >
Quable PIM integration >
Configure Quable

Configure Quable connector¶

You can customize the behavior of the Quable integration by using the following configuration.

Configuration example¶

In config/packages/ibexa_connector_quable.yaml, specify your configuration by using the ibexa_connector_quable key:

ibexa_connector_quable:
    enabled: true
    instance_url: 'https://example.quable.com'
    api_token: '<your_api_token>'
    channel_code: '<channel_code>'
    webhook_secret: '<webhook authorization header>' # Needed for webhook authentication
    language_map:
        eng-GB: en_GB
        fre-FR: fr_FR
    throw_on_invalid_criteria: '%kernel.debug%'
    throw_on_invalid_mapping: '%kernel.debug%'
    cache:
        enabled: true
        attribute: true
        attribute_group: true
        product: true
        product_type: true

Configuration options¶

Parameter	Default value	Description
`enabled`	`false`	Enables the connector.
`instance_url`	string	Base URL of your Quable instance, for example `https://example.quable.com`.
`api_token`	string	Read Access API token used to authenticate requests to Quable.
`channel_code`	string	Code of the Quable channel used as the source of product data.
`webhook_secret`	string	Secret expected in the webhook authorization header.
`language_map`	Empty	Maps Ibexa DXP language codes (for example, `eng-GB`) to Quable locale codes (for example, `en_GB`). For more information, see Set up Quable languages
`throw_on_invalid_criteria`	`%kernel.debug%`	Controls behavior for unsupported search criteria: `true` throws an exception, `false` only logs unsupported criteria.
`throw_on_invalid_mapping`	`%kernel.debug%`	Controls behavior for mapping errors during data transformation: `true` throws an exception, `false` only logs mapping errors.
`cache.enabled`	`true`	Global cache switch for the connector. When `false`, cache decorators use only in-memory cache.
`cache.attribute`	`true`	Enables caching for attribute definition requests.
`cache.` `attribute_group`	`true`	Enables caching for attribute group requests.
`cache.` `product`	`true`	Enables caching for product requests.
`cache.` `product_type`	`true`	Enables caching for product type requests.

In production environments, it's recommended to:

keep the api_token and the webhook_secret secure
enable caching for better performance, using Redis or Valkey as persistence cache
disable throw_on_invalid_criteria and throw_on_invalid_mapping to prevent non-critical errors from causing application crashes