Developer guidelines

Introduction to Synerise API

Synerise RESTful APIs are a quick and simple way to integrate your systems with Synerise

Synerise API Reference

Learn how to access all the information available in our API Reference

Authorization

Synerise uses JSON Web Tokens as the authorization method in most endpoints

Customers

Create and manage customer profiles and accounts

Events

Manage events with Synerise API

Schema Builder

Schemas allow you to store, manage, combine data; and more.

Getting started

The initial configuration needed to use the full capabilities of Synerise on your website

Customer identification

How Synerise identifies your customers to keep track of their activity, even when they are not registered

Synerise storage

An explanation of cookies used by the Synerise platform

Event tracking

Everything your customers do is recorded in the system

OG Tags

OG tags can be used to easily manage your product catalogs

Transactions

SDK methods used to track transactions on your website

Tracking form data

Newsletter agreements

Learn how to enable and disable newsletter agreements

Authenticating requests with JSON Web Tokens (JWT)

JWT allows you to verify a customer's identity when sending requests

Customer UUIDs

Supplementary procedures: create and set/reset UUIDs

Tracking cart status

Cart status can be tracked using custom events

Third-party and first-party tracking

You can configure Synerise tracking to be recognized as first-party and avoid blocking it by browsers

Method reference

All methods from the Synerise Web SDK

Getting started

The initial steps you need to perform before you can use the full capabilities of our SDK

Huawei integration

The initial steps you need to integrate SDK with Harmony OS.

Push notifications

Configure Google Firebase Cloud Messaging and extend your application to handle incoming push payload

Campaigns

You can use our SDK to handle push notifications and banners available in the Campaigns module

Event tracking

Everything your customers do in your mobile application is recorded in the system in real time

Customer identification

Actions are tracked even if a customer is anonymous, but authentication enables more efficient communication

Promotions

You can work with promotions and vouchers directly by the SDK

Content widget

This section describes our Content Widget and how to embed it within your application

Settings

You can change some SDK settings directly from your app without the need to reinitialize

Miscellaneous

Other features in Synerise Android SDK

Class reference

This section shows all public Android SDK classes

Method reference

Method reference for Synerise Android SDK

SDK callbacks

A list of all our android SDK Callbacks

Getting Started

The initial steps you need to perform before you can use the full capabilities of our SDK

Push Notifications

Setting up Push Notifications and handling incoming push payloads from Synerise

Campaigns

You can use our SDK to handle push notifications and banners available in the Campaigns module

Event Tracking

Everything your customers do in your mobile application is recorded in the system in real time

Customer Identification

Actions are tracked even if a customer is anonymous, but authentication enables more efficient communication

Loyalty

You can work with promotions and vouchers directly by the SDK

Content Widget

This section describes our Content Widget and how to embed it within your application

Settings

You can change some SDK settings directly from your app without the need to reinitialize

Miscellaneous

Rest of the functionality in SDK

Class Reference

This section shows all public iOS SDK classes

Method Reference

Method reference for Synerise iOS SDK

SDK Delegates

A list of all our iOS SDK Delegates

Getting Started

The initial steps you need to perform before you can use the full capabilities of our SDK

Push Notifications

Setting up Push Notifications and handling incoming push payloads from Synerise

Campaigns

You can use the SDK to handle our mobile campaigns

Event Tracking

Everything your customers do in your mobile application is recorded in the system in real time

Customer Identification

Actions are tracked even if a customer is anonymous, but authentication enables more efficient communication

Settings

You can change some SDK settings directly from your app without the need to reinitialize

Error Handling

Dealing with errors in our SDK

Class Reference

This section shows all public React Native SDK classes

Method Reference

A list of all our React Native SDK Methods

SDK Listeners

A list of all our React Native SDK Listeners

Insert usage

How inserts can be used in Synerise

Jinjava tests

You can test values returned by jinjava against different conditions

Jinjava filters

You can transform and manipulate values

Jinjava tags

Details of tags that you can use in inserts

Recommendation inserts

Insert usage in Recommendations

Automation inserts

This article describes how to use Jinjava in Automation

Data transformation inserts

Insert usage in data transformation

Dynamic content inserts

Instructions on advanced insert usage in dynamic content communication

Email inserts

Inserts that can be used in email communication

Webpush inserts

Learn how to use inserts in webpush messages

Filters

Filters are the basic building blocks of an IQL query

Context

Context allows you to use attributes of profiles or other items in filters

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

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

Installation and configuration

Learn how to install and configure SDK in your mobile app

Settings

You can change some SDK settings directly from your app without the need to reinitialize

Configuring push notifications

Learn how to implement push notifications in your mobile app

Customer identification and authorization

Check how you can set customer identification for apps in Android, iOS, and React Native

Event tracking

Implement event tracking in your Android, iOS, and React Native apps

Transactions

Learn how to track transactions in mobile SDK

Campaigns

You can use our SDK to handle Synerise campaigns

Loyalty

Find out how to implement promotions and vouchers in your mobile application

Displaying AI recommendations

Find out the methods of displaying AI recommendations in a mobile app

Miscellaneous

Rest of the functionality in SDK

Listeners and delegates

SDK callbacks and delegates to communication with app

Class reference

Class reference for Android, iOS, and React Native

Method reference

Method reference for Android, iOS, and React Native