Skip to content

Update documentation with User.com API usage, cookie domain handling,… #49

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.

Sign up for GitHub

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

Merged
tomkalon merged 1 commit into from
Oct 3, 2025
Merged

Update documentation with User.com API usage, cookie domain handling,… #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions doc/adjustments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ There is designated validator to check if request payload contains required fiel
If there will be any field added by User.com, you can adjust this validator to check if this field is present in request payload.
Also, in `BitBag\SyliusUserComPlugin\Assigner\AgreementsAssigner` you can adjust existing logic to assign agreements to customer in a way that suits your needs.

The endpoint is exposed in `Swagger` under `UserComAgreements`, making it easy to test and explore directly from the API documentation.

>If you use several channels, remember to select one of the available channels using the get method and parameters before using the API:
`?_channel_code=CHANNEL_CODE`

```php
public function assign(CustomerInterface $customer, array $agreements): void
{
Expand Down
5 changes: 5 additions & 0 deletions doc/functionalities.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,8 @@ The **BitBagSyliusUserComPlugin** integrates **User.com** with Sylius-based stor

### 7. User information object
- you can use `user_com_customer_info` in browser console to check currently logged in customer data

### 8. Webhook Endpoint: Updating User Marketing Consents
- Exposes a dedicated endpoint for handling User.com webhooks (`UserComAgreements` in `Swagger`),
allowing the update of user marketing consents. By default, it manages the `subscribedToNewsletter` flag,
but the mechanism is fully extensible to support additional types of consents.”
5 changes: 5 additions & 0 deletions doc/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,13 @@
USER_COM_FRONTEND_API_KEY=""
USER_COM_ENCRYPTION_KEY=your-32-character-long-key
USER_COM_ENCRYPTION_IV=your-16-character-long-iv
USER_COM_COOKIE_DOMAIN=""
MESSENGER_USER_COM_ASYNCHRONOUS_DSN=""
```
- You can find the `USER_COM_FRONTEND_API_KEY` in the User.Com integration guide for `Google Tag Manager (Settings->Setup & Integrations)`.
- `USER_COM_COOKIE_DOMAIN` is optional, if not set, cookies will be set for the current domain.


3. Add plugin dependencies to `config/bundles.php` file. Make sure that none of the bundles are duplicated.
```php
return [
Expand Down