- 23 Oct 2024
- 1 Minute to read
- DarkLight
- PDF
Overview of the Notification SDK
- Updated on 23 Oct 2024
- 1 Minute to read
- DarkLight
- PDF
The OneSpan Notification SDK provides an abstraction layer that allows notification support for mobile applications. On the client-side, the registration process is platform-dependent. On the server-side, you can send notifications with a simple function, independent of the target platform.
The Notification SDK Client can be used on a variety of devices and supports the following platforms:
Android devices:
Minimum Android 7 (API level 24)
Target Android 14 (API level 34)
iOS devices:
iOS 14 or later
Swift 5.0 or later
Xcode 15 or later
The Notification SDK Server can be used on a variety of devices and supports the following platforms:
Notification SDK Server Java edition: Java-enabled platforms (Java Development Kit (JDK) 8 and later)
For Windows only: Notification SDK Server .NET edition: .NET 6 and later
The Notification SDK Server can be used on a variety of devices and supports the following platforms:
Notification SDK Server Java edition: Java-enabled platforms (Java Development Kit (JDK) 8 and later)
For Windows only: Notification SDK Server .NET edition: .NET Framework 6 and later
Registration process
The Notification SDK Client handles registration with a unified registration function. When the registration process is completed, the client application and the back end receive a Notification Identifier. Registration process with OneSpan Notification SDK illustrates the registration process with the SDK.
Registration process with OneSpan Notification SDK
OneSpan Notification Identifier
The OneSpan Notification Identifier is unique to the client device, regardless of the platform (i.e. Android, iOS etc.). It is a unique hexadecimal string with a maximum length of 2064 characters that the Notification SDK Client assigns to the client application. It must be sent to the back end for later use.
When the Notification SDK Server sends a notification, it uses the OneSpan Notification Identifier to address the correct client device on the dedicated Push notification provider.
Notification content
The payloads the OneSpan Notification SDK transmits are strings. Depending on the target platform, different size limitations may apply. For more information about these limitations, refer to the respective platform documentation.
Notification delivery
The Notification SDK Server uses the OneSpan Notification Identifier to recognize the target device platform and apply the correct sending procedure. This comprises the following:
Connect to the correct push notification provider with the appropriate credential.
Create a notification based on specific push notification provider requirements.
Send the notification.
On the client-side, the Notification SDK Client provides a unified way to receive and parse incoming notifications. Notification delivery process with OneSpan Notification SDK illustrates the notification delivery process.
Notification delivery process with OneSpan Notification SDK