Digital Properties Overview
The Digital Properties Module allows you to create, edit, review, and disable applications and server to server API connections (also known as properties) which customers interact with as part of their experience with your brand. From within the Digital Properties Module, you can configure push notifications for native mobile apps, view the API key and secret created by the platform for your properties and specify other relevant information.
Examples of digital properties could be native mobile applications that use the SessionM SDK or your website, which communicates with the SessionM Platform via server-side APIs.
Your platform developers would typically access the Digital Properties Module to configure their API keys, set up push notifications for their native mobile apps, review testing status and set up test devices to validate that their applications are working as expected.
Digital Properties Dashboard
When you open the Digital Properties Module, you see a table of the configured properties that exist within your organization.
Along with the listed properties, a number of related fields are present, including:
Property Status – Current status of the property. Status values include:
- Live – Property is able to submit customer interaction data to the platform.
- Test – Property is configured but is in test mode. While it can submit customer interaction events and signals to the platform, these actions do not trigger live behaviors or campaigns.
- Disabled – Property has been disabled and events submitted using its API keys are ignored by the platform.
Property Platform – The platform on which the property is based. The platform can be iOS, Android, a browser or an API client, as explained below:
- iOS – Native mobile apps running on Apple iPhones or iPads.
- Android – Native mobile apps running on Android-powered phones or tablets.
- Browser – Web sites or properties hosted by you.
- API Client – Server platforms which are controlled by you that feed data into the SessionM Platform on behalf of your customers.
Property Name – This is the name of your digital property. When selected, the Property Details view is shown.
Property Reporting Metrics – Dashboard section that registers various metrics on membership and activity within your properties. These metrics are driven by the time range selector at the top of the table. Metrics include:
- Registered Visitors – Number of visitors who are registered within the selected time period.
- Active Members – Number of active loyalty program members in this property during the selected time period.
- Registrations – Number of registration events in the property during the selected time period.
- Engagements/Active Members – Percentage of engagement events in the property per active member during the selected time period.
Adding a Digital Property
You can add a new digital property by clicking on the Add Digital Property button in the dashboard view of the module. This opens a modal window in which you can configure the property’s values.
When adding a new property, first choose the type of property being added (Browser, iOS App or Android App).
Add a Browser Property
To add a browser property, enter the URL and the name. Then select the rating and category of your site from the respective drop down lists. You also need to add an image for both the desktop and the mobile UIs. Click the Save button to create your property.
Add a Mobile Property
To add a mobile property, enter the app store URL and name. Then select the rating and category of your mobile property from the respective drop down lists. You also need to add an icon in the correct dimensions, as referenced in the modal window. Click the Save button to create your property.
Managing a Digital Property
Managing a property consists of multiple configuration options including the API key & secret, API endpoint, push notifications and testing settings.
API Key and Secret
Both public (API Key) and private (API Secret) keys are used to distinguish and validate from the SessionM Platform to your digital property.
All digital properties are created with an API key, which uniquely references them in the SessionM Platform. Each digital property has its own API key, and you cannot use one API key for two different digital properties.
All properties are also created with an API secret, which is a private key used to distinguish and validate requests from a SessionM Platform SDK or a server-to-server API.
For a usage example of an API key in an SDK implementation, please see the appropriate quick start guide for each platform in Related Topics.
Do not store the API secret in your mobile property. As a best practice, only use it in a server-to-server API context.
All digital properties need to communicate with their instance of the SessionM Platform. The API endpoint for your instance of the SessionM Platform is exposed for server-to-server API requests.
SDK Testing Console
This SDK Testing console lets you see activity coming from test devices and allows you to test integrations in real-time to confirm that the digital property you are implementing is communicating with the platform.
The SDK Testing console shows events from configured test devices using the SessionM Mobile SDK. It does not show events once your property is set to “Live” status.
Add/Manage Test Devices
The Add/Manage Test Devices feature allows you to add the Google Ad ID or Apple IDFA to the SessionM Platform for your test devices, so you can view their events in the SDK Testing console.
In the area to the right of the SDK Testing window, you can add your test devices. Tap the Add Device button and enter the Google Ad ID, Android Device ID or iOS IDFA, and it is added to the list. It may take up to five minutes for the system to recognize your test device.
If your device has reached any action limits or caps, you can reset the limits with the Reset button.
Using QR Codes
The API QR Code area on the digital property detail view contains specific information pertaining to the digital property, such as the API code, S2S API secret and digital property name.
The QR code encapsulates the above information (property name, API key, API secret, endpoint) so it can be easily scanned by apps during the development process.
If you have access to the SessionM tour app, scanning the API QR code using the in-app scanner prompts the tour app to load, with the settings for your particular organization.
Push Notification Configuration
Configuring push notifications is necessary if you wish to use the SessionM Platform to send push notifications to your applications.
Configuration Overview – This push notification configuration varies based on the operating systems of the devices you are trying to reach. The two configuration options are:
- Uploading the PEM files you receive after enabling push notification features in Apple’s developer portal for iOS.
- Adding the key values associated with your app in Google’s ecosystem for Android.
iOS Configuration – Upload the PEM certificates that are associated with your app. Be sure to select the correct environment (Sandbox or Live) for the certificate(s) you are uploading.
Android Configuration – To configure Google Cloud Messaging for Android properties, just add the push message ID you set up inside the Google developer environment in the Play Store for your Android application. Edit your property, and add this value to the Push Message ID field.
For detailed iOS and Android configuration instructions, explore the SessionM Platform SDK documentation located in the Related Topics.
Set Property Live
Once your property settings have been configured, it can then be set live.
Simply click the Go Live button within the property configuration view to take the property out of Test mode and set it to “Live” on the platform.