| Info |
|---|
Please click here for the English documentation. |
Vorwort
Wir freuen uns, dass Sie sich für unser Plugin Push Notifications (OneSignal) entschieden haben.
...
Sollten Sie Vorschläge zur Weiterentwicklung des Plugins haben oder individuelle Anpassungen wünschen, zögern Sie nicht, uns zu kontaktieren. Registrieren Sie sich hierzu unter https://www.synergy-networks.de/konto#show-registration und erstellen ein Ticket für unser Entwicklerteam. Wir setzen uns anschließend umgehend mit Ihnen in Verbindung.
| Info |
|---|
Eine Schritt-für-Schritt-Anleitung, wie Sie ein Ticket bei SYNERGY NETWORKS erstellen können finden Sie in hier Support-Ticket bei SYNERGY NETWORKS. |
...
Anleitung
Wie Sie unser Plugin Push Notifications (One Signal) nach Ihren Anforderungen anpassen, zeigen wir Ihnen Schritt für Schritt in dieser Dokumentation.
...
Initiale Veröffentlichung
...
Foreword
We are pleased that you have chosen our plugin Push Notifications (OneSignal).
The plugin allows you to integrate push notifications based on the free service from OneSignal into your shop, independently for each main or subshop with its own domain.
Language shops with a virtual URL provide push notifications through the domain of the main shop. The language setting of the shop is provided to OneSignal as a tag, allowing for user segmentation based on language setting. A detailed plugin configuration allows you to explicitly customize the design and texts of the signup bell and dialogs for each shop.
If you have suggestions for the further development of the plugin or wish for individual customizations, please do not hesitate to contact us. To register, please go to https://www.synergy-networks.de/konto#show-registration and create a ticket for our development team. We will then get in touch with you promptly.
| Info |
|---|
A step-by-step guide on how to create a ticket with SYNERGY NETWORKS can be found here Support-Ticket bei SYNERGY NETWORKS. |
...
Instructions
We will show you step by step how to customize our plugin Push Notifications (OneSignal) according to your requirements in this documentation.
...
Table of Contents
| Table of Contents | ||
|---|---|---|
|
...
1. System Requirements
Please note that the OneSignal implementation of our plugin requires full support of the HTTPS protocol by your shop!
...
2. Installation and Update
2.1 Testing/Renting the Plugin
You have the option to extensively test the plugin before renting it. We provide you with a Shopware demo shop to test the plugin in the backend and frontend.
You can access the frontend at demo6.synergynetworks.de and the backend at https://demo6.synergynetworks.de/admin
Username: push
Password: notifications
After completing the order for the rental version in the Shopware store, downloads and licenses will be available in the license management of your Shopware account.
2.2 Installing/Updating the Plugin
To install the plugin:
open Extensions > My Extensions in the Shopware administration,
install or update the plugin,
if not already done, activate the plugin.
...
3. OneSignal Account
The free push notification service from OneSignal is used to manage and send push notifications. Please create an account with OneSignal at the following URL: OneSignal Registration
...
3.1 Logging In
Click on LOG IN in the navigation of the page and use one of the options listed in the dialog to create your OneSignal account.
...
3.2 OneSignal App
3.2.1 Creating a OneSignal App
...
After logging in to OneSignal, a dialog box will appear to guide you through the initial setup steps. On the last page of the dialog, select “New App/Website” (1).
...
Enter a Name (1) for your new OneSignal app. Enter the Company Name (2).
A OneSignal app manages push notifications for each domain (this corresponds to a main or subshop). Ideally, you should use the domain of the respective shop, e.g., mein-shop.de.
Select the setting “Web" (3).
...
3.2.2 Web Configuration
...
Here, select Custom Code (1). Enter the Shop Name (2). Provide the URL (3) of the shop for which you are setting up the OneSignal app. Optionally, you can upload or provide a URL for a custom Notification Icon (4). Save (5) your settings.
| Info |
|---|
Note: Please be aware during setup that we strongly recommend switching your site to https if this has not already been done. |
...
3.2.3 APP-ID and Safari Web ID
...
After saving, another page of the Web Configuration will open. Copy the APP-ID (1) (under the point Add Code to Site) and enter it in the plugin configuration in your Shopware administration. Copy the Safari Web ID (2) and enter it in the plugin configuration in your Shopware administration.
| Info |
|---|
In principle, you can always manage your OneSignal apps via the side menu under the point “All Apps”. Here you can create, delete, or edit apps. |
...
3.2.4 API Key
...
To create the API key, go to the Settings (1) and select the Keys & IDs (2) setting.
...
Now select the Add Key (1) setting.
...
Enter a Name (1) in the input field and generate the API Key (2).
...
Copy the API Key (1) and enter it in the plugin configuration in your Shopware administration.
...
4. Plugin Configuration
The plugin configuration in your Shopware administration is specific to each shop and is divided into several sections. The settings of the individual sections are explained in more detail below.
4.1 Basic Settings
In the basic settings, the connection to the OneSignal Notification Service is configured. Enter the App ID that was issued to you when creating the OneSignal app for this domain, as well as the name and short name of your page or company. You must enter the API key to validate/check your credentials.
...
(1) Enter your APP-ID here, which was issued to you when creating the OneSignal app (see 2.2.4) for this domain.
(2) Enter the name of your company or your page here.
(3) Enter the short name of your company or your page here.
(4) Enter the Safari Web ID that was issued to you when creating the OneSignal app (see 2.2.4) for this domain.
(5) Enter the API key that was issued to you when creating the OneSignal app (see 2.2.5) for this domain.
(6) Validate the credentials.
| Info |
|---|
Note: Please note that when configuring a language shop (shop with a virtual URL like https://mein-shop.de/en), the configuration of the connection data must be identical to that of the main shop! |
...
4.2 Cookie Settings
| Info |
|---|
Note: To display in the frontend, the necessary cookies must be accepted by the user/customer. Use the standard cookie notice from Shopware in your shop: Either "Accept all cookies" or in the configuration of the cookie pre-setting > Comfort function > One Signal: Accept push notifications.  |
...
(1) Selection to show or not show the selection field for cookie settings within the comfort function of the standard cookie notice from Shopware.
(2) If you use Usercentrics for cookie management on your website, please enable it.
(3) Please specify the title of the cookie that you have created in Usercentrics for OneSignal.
...
4.3 Settings
4.3.1 Signup Bell Settings
...
The settings for the signup bell are self-explanatory. The input of values for the margins is possible in CSS-compliant sizes (px, %, em, etc.). The margin left or right is only considered if the signup bell is also positioned left or right.
...
4.3.2 Signup Bell Texts
...
The texts for the signup bell are already pre-filled with standard values. You can customize these texts according to your needs and should definitely do so for foreign language subshops.
...
4.3.3 Signup Bell Colors
...
To adapt the signup bell to the design of your shop, you can specify all relevant color values of the signup bell yourself. You can enter colors in the form of hex values, RGB specifications, or as strings.
...
4.3.4 Welcome Message Texts
...
Here you configure the title and message of the first push notification that the customer receives after signing up for push notifications.
...
4.3.5 Slide Prompt Settings
In this setting, you can configure the consent notification in the shop view.
...
(1) Delay of the prompt
Indicates after which page view the prompt will be displayed/loaded.
(2) Delay Time
Indicates the time (in seconds) that elapses before the prompt is displayed.
(3) Action Message
Enter your notification message here. The default is set to We would like to show you notifications about the latest news and updates.
(4) Accept Button
Enter the name of the button here. The default is set to Accept.
(5) Cancel Button
Enter the name of the button here. The default is set to Cancel.
...
5. Available Shopware Tags
In addition to the general tags offered by OneSignal, the plugin provides additional tags that you can use in the OneSignal dashboard to create segments. These segments use tag filters to define user groups to which they can send push notifications.
TagsTA | Filter Values |
|---|---|
user_id | not pre-filled |
user_type | abbreviation of the customer group |
salutation | mr, ms |
firstname | not pre-filled |
lastname | not pre-filled |
realname | first name last name |
birthdate | yyyy-MM-dd (e.g., 1965-05-02) |
gender | mr, ms, company (billing address) |
postcode | postal code of the billing address |
region | city (billing address) |
birthyear | yyyy |
user_type_firstlogin | yyyyMMdd (e.g., 20161105) |
user_type_lastlogindate | yyyyMMdd |
user_type_lastlogintime | hhmmss (e.g., 163422) |
user_type_newsletter | 0, 1 |
user_type_shop | name of the shop |
...
6. Changelog
Version 3.3.0
An improvement regarding the subscription issue for Safari users has been made.
Version 3.2.0
An integration for cookie management with Usercentrics has been implemented.
Version 3.1.0
An integration for cookie management with Usercentrics has been implemented.
Version 3.0.0
Compatibility with Shopware 6.6
Version 2.1.0
Updated according to Onesignal v11.0
Version 2.0.0
Compatibility with Shopware 6.5
Version 1.0.7
Compatibility with Shopware 6.4.15.0. Now directly compatible with minor updates.
Version 1.0.6
Compatibility with Shopware 6.4.14.0
Version 1.0.5
Compatibility with Shopware 6.4.13.0
Version 1.0.4
Compatibility with Shopware 6.4.12.0
Version 1.0.3
Compatibility with Shopware 6.4.11.1
Version 1.0.2
New configuration added to change the cookie group of the plugin according to the sales channels.
Version 1.0.1
The API test button is now compatible with new versions. Function for merging cookies revised.
Version 1.0.0
Initial release
...