Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions docs/cdp/raptor_integration/connector_configuration.md
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

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/raptor_integration/connector_configuration.md#L27

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/cdp/raptor_integration/connector_configuration.md", "range": {"start": {"line": 27, "column": 149}}}, "severity": "INFO"}
- `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

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/raptor_integration/connector_configuration.md#L28

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/cdp/raptor_integration/connector_configuration.md", "range": {"start": {"line": 28, "column": 111}}}, "severity": "INFO"}
- `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

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/raptor_integration/connector_configuration.md#L29

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/cdp/raptor_integration/connector_configuration.md", "range": {"start": {"line": 29, "column": 45}}}, "severity": "INFO"}
- `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

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/raptor_integration/connector_configuration.md#L30

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/cdp/raptor_integration/connector_configuration.md", "range": {"start": {"line": 30, "column": 27}}}, "severity": "INFO"}

Check notice on line 30 in docs/cdp/raptor_integration/connector_configuration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/raptor_integration/connector_configuration.md#L30

[Ibexa.ByUsing] Prefer 'by using' or 'with' to plain 'using'.
Raw output
{"message": "[Ibexa.ByUsing] Prefer 'by using' or 'with' to plain 'using'.", "location": {"path": "docs/cdp/raptor_integration/connector_configuration.md", "range": {"start": {"line": 30, "column": 46}}}, "severity": "INFO"}

Check notice on line 30 in docs/cdp/raptor_integration/connector_configuration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/raptor_integration/connector_configuration.md#L30

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/cdp/raptor_integration/connector_configuration.md", "range": {"start": {"line": 30, "column": 153}}}, "severity": "INFO"}
- `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

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/raptor_integration/connector_configuration.md#L31

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/cdp/raptor_integration/connector_configuration.md", "range": {"start": {"line": 31, "column": 27}}}, "severity": "INFO"}
- `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

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/raptor_integration/connector_configuration.md#L32

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/cdp/raptor_integration/connector_configuration.md", "range": {"start": {"line": 32, "column": 218}}}, "severity": "INFO"}
- `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

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/raptor_integration/connector_configuration.md#L33

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/cdp/raptor_integration/connector_configuration.md", "range": {"start": {"line": 33, "column": 131}}}, "severity": "INFO"}

## Customer ID

Check notice on line 35 in docs/cdp/raptor_integration/connector_configuration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/raptor_integration/connector_configuration.md#L35

[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings
Raw output
{"message": "[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings", "location": {"path": "docs/cdp/raptor_integration/connector_configuration.md", "range": {"start": {"line": 35, "column": 4}}}, "severity": "INFO"}

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).

Check notice on line 40 in docs/cdp/raptor_integration/connector_configuration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/raptor_integration/connector_configuration.md#L40

[Ibexa.SentenceLength] Keep your sentences to less than 30 words.
Raw output
{"message": "[Ibexa.SentenceLength] Keep your sentences to less than 30 words.", "location": {"path": "docs/cdp/raptor_integration/connector_configuration.md", "range": {"start": {"line": 40, "column": 70}}}, "severity": "INFO"}

Check warning on line 40 in docs/cdp/raptor_integration/connector_configuration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/raptor_integration/connector_configuration.md#L40

[Ibexa.VerySimply] Avoid using 'easily'.
Raw output
{"message": "[Ibexa.VerySimply] Avoid using 'easily'.", "location": {"path": "docs/cdp/raptor_integration/connector_configuration.md", "range": {"start": {"line": 40, "column": 226}}}, "severity": "WARNING"}

Check warning on line 40 in docs/cdp/raptor_integration/connector_configuration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/raptor_integration/connector_configuration.md#L40

[Ibexa.VerySimply] Avoid using 'just'.
Raw output
{"message": "[Ibexa.VerySimply] Avoid using 'just'.", "location": {"path": "docs/cdp/raptor_integration/connector_configuration.md", "range": {"start": {"line": 40, "column": 289}}}, "severity": "WARNING"}

![Account number](account_number.png)

## Recommendations API key

Check notice on line 44 in docs/cdp/raptor_integration/connector_configuration.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/raptor_integration/connector_configuration.md#L44

[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings
Raw output
{"message": "[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings", "location": {"path": "docs/cdp/raptor_integration/connector_configuration.md", "range": {"start": {"line": 44, "column": 4}}}, "severity": "INFO"}

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)
27 changes: 27 additions & 0 deletions docs/cdp/raptor_integration/raptor_connector.md
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
---

# SiteAccess-aware Raptor connector

Check notice on line 6 in docs/cdp/raptor_integration/raptor_connector.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/raptor_integration/raptor_connector.md#L6

[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings
Raw output
{"message": "[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings", "location": {"path": "docs/cdp/raptor_integration/raptor_connector.md", "range": {"start": {"line": 6, "column": 3}}}, "severity": "INFO"}

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

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/raptor_integration/raptor_connector.md#L18

[Ibexa.Lists] Verify list formatting: Full sentences should start with uppercase and end with a period. Sentence fragments should start with lowercase and have no period.
Raw output
{"message": "[Ibexa.Lists] Verify list formatting: Full sentences should start with uppercase and end with a period. Sentence fragments should start with lowercase and have no period.", "location": {"path": "docs/cdp/raptor_integration/raptor_connector.md", "range": {"start": {"line": 18, "column": 1}}}, "severity": "INFO"}

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.

Check notice on line 23 in docs/cdp/raptor_integration/raptor_connector.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/cdp/raptor_integration/raptor_connector.md#L23

[Ibexa.ByUsing] Prefer 'by using' or 'with' to plain 'using'.
Raw output
{"message": "[Ibexa.ByUsing] Prefer 'by using' or 'with' to plain 'using'.", "location": {"path": "docs/cdp/raptor_integration/raptor_connector.md", "range": {"start": {"line": 23, "column": 72}}}, "severity": "INFO"}

[[= cards([
"cdp/raptor_integration/connector_configuration",
], columns=3) =]]
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading