-
Notifications
You must be signed in to change notification settings - Fork 81
IBX-10688: SiteAccess-aware Raptor connector configuration documented in Dev-doc #3101
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 4 commits
92ae029
b138e44
e769a20
d16400a
72be3b9
23f96e6
03934df
65bd319
dadaacf
36e0183
2027610
ea6a782
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| --- | ||
| description: Step-by-step configuration procedure of SiteAccess-aware Raptor connector. | ||
| --- | ||
|
|
||
| ## Configuration | ||
|
|
||
| To configure Raptor connector, use the ibexa.system.<scope>.connector_raptor configuration key: | ||
|
|
||
| ```yaml | ||
| # config/packages/ibexa_connector_raptor.yaml: | ||
|
|
||
| ibexa: | ||
| system: | ||
| <scope>: | ||
| 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. | ||
|
Check notice on line 27 in docs/cdp/raptor_integration/connector_configuration.md
|
||
| - `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/). | ||
|
Check notice on line 28 in docs/cdp/raptor_integration/connector_configuration.md
|
||
|
julitafalcondusza marked this conversation as resolved.
Outdated
julitafalcondusza marked this conversation as resolved.
Outdated
|
||
| - `tracking_type` - defines how user events are sent to the tracking API. Possible values: | ||
|
Check notice on line 29 in docs/cdp/raptor_integration/connector_configuration.md
|
||
|
julitafalcondusza marked this conversation as resolved.
Outdated
|
||
| - `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. | ||
|
Check notice on line 30 in docs/cdp/raptor_integration/connector_configuration.md
|
||
| - `server` - tracking is handled on the backend, with events sent directly to the tracking API. It's not affected by ad blockers. | ||
|
Check notice on line 31 in docs/cdp/raptor_integration/connector_configuration.md
|
||
| - `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. | ||
|
Check notice on line 32 in docs/cdp/raptor_integration/connector_configuration.md
|
||
| - `recommendations_api_url` (optional) - overrides the default Raptor SaaS address, should be left unset unless a custom endpoint is required. | ||
|
Check notice on line 33 in docs/cdp/raptor_integration/connector_configuration.md
|
||
|
julitafalcondusza marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## Customer ID | ||
|
Check notice on line 35 in docs/cdp/raptor_integration/connector_configuration.md
|
||
|
|
||
| To find the value for the `customer_id` identifier, log in to Raptor Control Panel, and look for "Account number": | ||
|
|
||
| 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). | ||
|
Check notice on line 40 in docs/cdp/raptor_integration/connector_configuration.md
|
||
|
|
||
|  | ||
|
|
||
| ## Recommendations API key | ||
|
Check notice on line 44 in docs/cdp/raptor_integration/connector_configuration.md
|
||
|
|
||
| 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. | ||
|
julitafalcondusza marked this conversation as resolved.
Outdated
|
||
|
|
||
|  | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| --- | ||
| description: Step-by-step activation procedure of setting up SiteAccess-aware Raptor connector. | ||
| page_type: landing_page | ||
|
julitafalcondusza marked this conversation as resolved.
Outdated
|
||
| --- | ||
|
|
||
| # SiteAccess-aware Raptor connector | ||
|
Check notice on line 6 in docs/cdp/raptor_integration/raptor_connector.md
|
||
|
julitafalcondusza marked this conversation as resolved.
Outdated
|
||
|
|
||
| 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 | ||
|
Check notice on line 18 in docs/cdp/raptor_integration/raptor_connector.md
|
||
|
|
||
| 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. | ||
|
julitafalcondusza marked this conversation as resolved.
Outdated
julitafalcondusza marked this conversation as resolved.
Outdated
|
||
| Activation includes configuration, adding tracking scripts and events, and using [Page Builder]([[= user_doc =]]/content_management/pages/page_builder_guide/) blocks. | ||
|
Check notice on line 23 in docs/cdp/raptor_integration/raptor_connector.md
|
||
|
|
||
| [[= cards([ | ||
| "cdp/raptor_integration/connector_configuration", | ||
| ], columns=3) =]] | ||
Uh oh!
There was an error while loading. Please reload this page.