Developer Guides and SDKs

Browse the full catalog of Synerise developer guides and SDK references. Each entry links to the full guide.

API

API — Synerise RESTful APIs are a quick and simple way to integrate your systems with Synerise
Authorization — Synerise uses JSON Web Tokens as the authorization method in most endpoints
Profile authentication — Profiles are usually your customers, app users, website visitors
Introduction to API Authorization — This article explains the concepts needed to understand how to authorize over the API
IP access control — You can limit user access to a list of IPs
Synerise user authorization — The user is a person who performs actions in Synerise
Workspace authentication — Workspace authentication is used in most API integrations
Customers — Create and manage customer profiles and accounts
Customer devices — Depending on workspace configuration, customers may be required to confirm access from unknown devices
Merging profiles with the API — You can merge multiple profiles (their data and history) into one
Managing newsletter agreements with API — You can use the API to manage newsletter agreements of a profile
Customer profiles — Profiles can be created for activity tracking
Customer registration — Customers can create accounts that belong to them
Customer security configuration — Manage IP access, password policies, device authorization, and more
Customer account management — Customers can see, update, and delete their own data
Events — Manage events with Synerise API
Overwriting events — Overwrite existing events in the database
Sending events — Use the Synerise API to send events
Introduction to Synerise API — Synerise RESTful APIs are a quick and simple way to integrate your systems with Synerise
Recommendations API — Learn how to retrieve recommendations with the API
Recommendation API events — Implement gathering events for Decision and Automation Hub
Recommendation API filters — Add or modify filters in Recommendations API requests
Recommendation API requests — Make requests for a recommendation model or campaign
Recommendation API responses — Read the recommendation API responses
Index

Inserts

Inserts — To make full use of Synerise functionalities, you can use them as inserts when creating content for you website, e-mails, or mobile apps
Automation inserts — This article describes how to use Jinjava in Automation
Brickworks inserts — This article describes how to use Jinjava in the brickworks feature
Connection inserts — This article describes how to use Jinjava in connections
Dynamic content inserts — Instructions on advanced insert usage in dynamic content communication
Email inserts — Inserts that can be used in email communication
Jinjava tests — You can test values returned by jinjava against different conditions
Jinjava filters — You can transform and manipulate values
Data transformation inserts — Insert usage in data transformation
In-app message inserts — Insert usage in in-app messaging
Insert usage — How inserts can be used in Synerise
Mobile push inserts — Insert usage in mobile push notifications
Inserting recommendations — Inserts used to display recommendations
Screen views and Documents inserts — These inserts can be added to SVs and Documents retrieved with the SDKs and API
SMS inserts — Insert usage in text messages
Jinjava tags — Details of tags that you can use in inserts
Webpush inserts — Learn how to use inserts in webpush messages

Items Query Language (IQL)

Items Query Language (IQL) — IQL lets you create filters for recommendations, search results, and more
Context — Context allows you to use attributes of profiles or other items in filters
Filters — Filters are the basic building blocks of an IQL query
Functions — Functions offer additional possibilities of manipulating values
Logical operators — Logical operators allow you to add relations between filters
Validate and test IQL — You can use the validation endpoint to validate your filter and preview its results

Mobile SDK

Mobile SDK — Learn how to implement Android, iOS, React Native, and Flutter SDKs
Campaigns — You can use our SDK to handle Synerise campaigns
Action handling — Implement handling actions from campaigns
Basics — Basics about mobile campaigns
In-app message — Implement and configure in-app message campaigns
Silent push — Implement and configure silent push
Simple push — Implement and configure simple push campaigns
Class reference — Class reference for Android, iOS, and React Native
Android — Class reference for Android SDK
Campaigns — Classes related to campaigns
Client — Classes related to client
Content Widget — Content Widget classes in the Android SDK
Events — All event classes
SDK Lifecycle — Lifecycle classes in Android SDK
Miscellaneous — Miscellaneous classes in the SDK
Modules — Main modules classes
Promotions and Vouchers — Classes related to promotions and vouchers
Recommendations and Documents — Classes related to recommendations and documents
Flutter — Class reference for Flutter SDK
Campaigns — Classes related to campaigns
Client — Classes related to client
Events — Classes related to events
SDK Lifecycle — Lifecycle classes in Flutter SDK
Miscellaneous — Miscellaneous classes in the SDK
Modules — Classes for main modules
Promotions and Vouchers — Classes related to promotions and vouchers
Recommendations and Documents — Classes related to recommendations and documents
iOS — Class reference for iOS SDK
Campaigns — Classes related to campaigns
Client — Classes related to client
Content Widget — Content Widget classes in the iOS SDK
Events — Classes related to events
SDK Lifecycle — Lifecycle classes in iOS SDK
Miscellaneous — Miscellaneous classes in the SDK
Modules — Classes for main modules
Notification extensions — Notification extension classes in the SDK
Promotions and Vouchers — Classes related to promotions and vouchers
Recommendations and Documents — Classes related to recommendations and documents
React Native — Class reference for React Native SDK
Campaigns — Classes related to campaigns
Client — Classes related to client
Events — Classes related to events
SDK Lifecycle — Lifecycle classes in React Native SDK
Miscellaneous — Miscellaneous classes in the SDK
Modules — Classes for main modules
Promotions and Vouchers — Classes related to promotions and vouchers
Recommendations and Documents — Classes related to recommendations and documents
Configuring push notifications — Learn how to implement push notifications in your mobile app
Android — Implement push notifications in Android mobile app
Flutter — Implement push notifications in Flutter mobile app
iOS — Implement push notifications in iOS mobile app
React Native — Implement push notifications in React Native mobile app
Displaying AI recommendations — Find out the methods of displaying AI recommendations in a mobile app
With Content Widget — Embed an easily customizable view with AI recommendations
Android — This section describes our Content Widget and how to embed it within your Android application
iOS — This section describes our Content Widget and how to embed it within your iOS application
With documents and screen views — Create documents that contain recommendations and use dedicated method to display documents in your mobile application
Event tracking — Implement event tracking in your Android, iOS, and React Native apps
Installation and configuration — Learn how to install and configure SDK in your mobile app
Android — Installation and configuration for Android mobile apps
Flutter — Installation and configuration for Flutter mobile apps
Huawei integration for Android — The initial steps you need to integrate SDK with Harmony OS.
Huawei integration in Android SDK — Integrating the Synerise Android SDK with Harmony OS
Huawei integration in Flutter SDK — Integrating the Synerise Flutter SDK with Harmony OS
iOS — Installation and configuration for iOS mobile apps
React Native — Installation and configuration for React Native mobile apps
Listeners and delegates — SDK callbacks and delegates to communication with app
Android — Android listeners available in the SDK
Flutter — Flutter listeners available in the SDK
iOS — iOS delegates available in the SDK
React Native — React Native listeners available in the SDK
Loyalty — Find out how to implement promotions and vouchers in your mobile application
Method reference — Method reference for Android, iOS, and React Native
Android — A list of all our Android SDK methods
Campaigns — Handling notifications
Customer account management — Customer's personal data management
Customer authentication — Manage customer registration and authentication
Customer session — Customer sessions management
Content — Retrieve content to be displayed
SDK lifecycle — Lifecycle management
Promotions and Vouchers — Retrieve and activate promotions and discounts
Public interfaces — Public interfaces available in the Android SDK
Event tracking — Monitoring customer activity
Flutter — A list of all our Flutter SDK methods
Campaigns — Methods use for working with campaigns
Customer account management — Customer's personal data management
Customer authentication — Manage customer registration and authentication
Customer session — Customer session management
Content — Retrieve content to be displayed
SDK lifecycle — Lifecycle management
Promotions and Vouchers — Retrieve and activate promotions and discounts
Event tracking — Monitoring customer activity
iOS — A list of all our iOS SDK methods
Campaigns — Methods used for working with campaigns
Customer account management — Customer's personal data management
Customer authentication — Customer's authentication
Customer session — Customer sessions management
Content — Retrieve content to be displayed
SDK lifecycle — Lifecycle management
Promotions and Vouchers — Retrieve and activate promotions and discounts
Event tracking — Monitoring customer activity
React Native — A list of all our React Native SDK methods
Campaigns — Methods use for working with campaigns
Customer account management — Customer's personal data management
Customer authentication — Manage customer registration and authentication
Customer session — Customer session management
Content — Retrieve content to be displayed
SDK lifecycle — Lifecycle management
Promotions and Vouchers — Retrieve and activate promotions and discounts
Event tracking — Monitoring customer activity
Miscellaneous — Rest of the functionality in SDK
Overview — Find out what kind of possibilities mobile SDK integration opens
Sample projects on Github — Click here to access the links to Synerise Github projects
Settings — You can change some SDK settings directly from your app without the need to reinitialize
Transactions — Learn how to track transactions in mobile SDK
Profile identification, authentication, and management — Learn how to identify and authorize your mobile app users
External providers — Learn how to implement authentication through Facebook and Sign in with Apple
Profile management — Learn how customers are identified and how to manage a session
OAuth — Authenticate through your existing IT systems that have RESTful APIs
Profile identification — Find out which identification methods are supported in Synerise
Session management — Implement methods responsible for session management when a user is signed in
Simple Profile Authentication — Learn how to implement a simplified authentication in your mobile app
Synerise Authentication — Enable account registration and management through Mobile SDK and Synerise REST API

Google Merchant Center XML item feed

Google Merchant Center XML item feed — One of the options of uploading an item feed is to use a Google Merchant Center XML file

Web

Web — Event tracking, customer identification, cookies, Web SDK, and more
Advanced tracking code settings — Learn how to create or edit an existing tracking code without the creator
Tracking cart status — Cart status can be tracked using custom events
Synerise storage — An explanation of cookies used by the Synerise platform
"Do Not Track" mechanism — You can let visitors and mobile app users opt-out of tracking their activity
Event tracking — Everything your customers do is recorded in the system
Custom tracking domain — You can configure Synerise tracking to be recognized as first-party and avoid blocking it by browsers
Getting started — The initial configuration needed to use the full capabilities of Synerise on your website
Authenticating requests with JSON Web Tokens (JWT) — JWT allows you to verify a customer's identity when sending requests
Method reference — Methods from the Synerise Web SDK
Newsletter agreements — Learn how to enable and disable newsletter agreements
OG Tags — OG tags can be used to easily manage your product catalogs
Tracking form data — You can use forms in different contexts. Each form can send data to Synerise, using additional parameters that do not other uses of the…
Sending form data with API — You can send data from HTML forms by using the API instead of the SDK
Sending form data with JS SDK — Send data from HTML forms by using the JS SDK
Transactions and basket events — SDK methods used to track transactions and baskets on your website
Customer identification — How Synerise identifies your customers to keep track of their activity, even when they are not registered
Customer UUIDs — Supplementary procedures: create and set/reset UUIDs