diff --git a/docs/cdp/raptor_integration/connector_configuration.md b/docs/cdp/raptor_integration/connector_configuration.md new file mode 100644 index 0000000000..6258501a51 --- /dev/null +++ b/docs/cdp/raptor_integration/connector_configuration.md @@ -0,0 +1,53 @@ +--- +description: Step-by-step configuration procedure of SiteAccess-aware Raptor connector. +--- + +## Configuration + +To configure Raptor connector, use the ibexa.system..connector_raptor configuration key: + +```yaml +# config/packages/ibexa_connector_raptor.yaml: + +ibexa: + system: + : + connector_raptor: + enabled: true + customer_id: ~ # Required + tracking_type: client # One of: "client" or "server" + + # Raptor Recommendations API key + recommendations_api_key: ~ # Required + + # Raptor Recommendations API URL, optional, set by default + recommendations_api_url: '%ibexa.connector.raptor.recommendations.api_url%' +``` + +- `enabled` - enables or disables the Connector for a given scope, default value: `true`. If set to `false`, no tracking or recommendation requests are executed. +- `customer_id` - an identifier used to authenticate requests to the Recommendation Engine. This value is can be found as `Account number` in [Raptor Control Panel](https://controlpanel.raptorsmartadvisor.com/). +- `tracking_type` - defines how user events are sent to the tracking API. Possible values: + - `client` - tracking is executed in the browser using JavaScript snippets generated by Twig functions and included in templates. This approach may be blocked by ad blockers. + - `server` - tracking is handled on the backend, with events sent directly to the tracking API. It's not affected by ad blockers. +- `recommendations_api_key` - an API key used to authenticate requests to the Recommendations API. This key allows the Connector to retrieve personalized recommendations from the Recommendation Engine. This value can be found as `API key` in Raptor Control Panel. +- `recommendations_api_url` (optional) - overrides the default Raptor SaaS address, should be left unset unless a custom endpoint is required. + +## Customer ID + +To find the value for the `customer_id` identifier, log in to Raptor Control Panel, and look for "Account number": + +A. A. In the top-left corner, above the account name, you can find the account number for the currently active account. +B. Click the arrow icon in the top-left corner to expand the window. There you can see a list of all your accounts, with their numbers shown in the “Account number” column on the right (if you have multiple accounts, you can easily locate and copy the number of any of your accounts, not just the active one). + +![Account number](account_number.png) + +## Recommendations API key + +To find the value for the `recommendations_api_key`, log in to Raptor Control Panel, and look for "API key". +To do it, in the left panel, open the **Recommendations** section, and select **Website**. +Next, click on the Web module you’re interested in. +In the top-right corner, click the three-dot icon and select **API information**. +A new window appears, where you can find the "API key" value. +Click on the **Show API information** and copy the number. + +![API key](api_key.png) diff --git a/docs/cdp/raptor_integration/raptor_connector.md b/docs/cdp/raptor_integration/raptor_connector.md new file mode 100644 index 0000000000..eb35a449e7 --- /dev/null +++ b/docs/cdp/raptor_integration/raptor_connector.md @@ -0,0 +1,27 @@ +--- +description: Step-by-step activation procedure of setting up SiteAccess-aware Raptor connector. +page_type: landing_page +--- + +# SiteAccess-aware Raptor connector + +The SiteAccess-aware [Raptor](https://www.raptorservices.com/) connector provides a seamless integration between [[= product_name =]] and Raptor Recommendation Engine. + +Its primary goal is to enable editors and managers to deliver personalized experiences across digital channels, which helps to increase conversion rates, drive sales, and improve user engagement. + +By combining content management capabilities with advanced recommendation features, the Connector allows teams to build and manage personalized experiences directly within a single platform. + +This connector ensures a smooth and unified integration layer, enabling: + +- event tracking through the tracking API +- personalized content delivery through the Recommendations API +- flexible, SiteAccess-aware configuration + +This approach reduces integration complexity while providing a scalable foundation for personalization use cases across multiple sites and markets. + +Follow a step-by-step procedure that allows you to activate SiteAccess-aware Raptor connector. +Activation includes configuration, adding tracking scripts and events, and using [Page Builder]([[= user_doc =]]/content_management/pages/page_builder_guide/) blocks. + +[[= cards([ + "cdp/raptor_integration/connector_configuration", +], columns=3) =]] diff --git a/mkdocs.yml b/mkdocs.yml index 158817bf9a..f429616365 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -508,6 +508,9 @@ nav: - CDP add client-side tracking: cdp/cdp_activation/cdp_add_clientside_tracking.md - CDP data export schedule: cdp/cdp_data_export_schedule.md - CDP data customization: cdp/cdp_data_customization.md + - Integration with Raptor: + - Integration with Raptor: cdp/raptor_integration.md + - Connector configuration: cdp/raptor_connector_configuration.md - Search: - Search: search/search.md - Search engines: