Introduction

The Datami OutSystems SDK provides libraries, sample code, and documentation to help developers build Sponsored Data-enabled applications.

Supported Use Cases

1. Full App Sponsorship – All HTTP(S) traffic is sponsored.
2. Specific URL Sponsorship – Sponsorship for individual HTTP(S) URLs.

Assumptions

1. API access key provided by Datami.
2. Sponsored Data campaign configured in Datami portal.
3. Physical Android device with a SIM on supported network.

Integration Steps

1. Install DataMi Content Sponsor Plugin available on Forge.
2. Add the DataMi Content Sponsor Plugin component as a dependency in the component that is to be sponsored and select all DataMi Content Sponsor Plugin itens.
   
3. Call the Datami License anywhere in the application so that the SDK can start.
4. Configure Extensibility Configurations in your app:
   1. Add the settings to Preferences/Global:
   2. If different AppIDs are used for iOS and Android, configure Preferences as

      follows:

Using Plugin Methods

After installing and configuring the Datami OutSystems SDK as described above, you can use the available Client Actions to interact with the Datami Sponsored Data features in your mobile app.

1. Import the Actions
   1. In Service Studio, add a reference to the DataMi Content Sponsor Plugin in your module. 
   2. Under Client Actions, you will find all available methods, such as: 
      1. GetSdState
      2. GetAnalytics
      3. UpdateUserId
      4. UpdateUserTag
      5. GetSDAuth
      6. StopSponsoredData
      7. StartSponsoredData
      8. GetClientIP
2. Example Usage 
   1. Get Current SD State 
      1. To check the current sponsored data state: 
         1. Add a local variable (e.g., SdStateText) to your screen. 
         2. Add a button with an OnClick event. 
         3. In the OnClick action, call the GetSdState Client Action. 
         4. Assign the output (SdState) to your local variable. 
         5. Optionally, show a notification with the result. 
   2. Start/Stop Sponsored Data 
      1. To start or stop a sponsored data session, simply call the respective Client Action:
         1. StartSponsoredData: Initiates a sponsored data session.
         2. StopSponsoredData: Ends the sponsored data session.
      2. You can use the Success output to confirm the operation and show a notification to the user. 
      3. Note:
         1. Only call StartSponsoredData after call StopSponsoredData.
   3. Get Analytics 
      1. To retrieve usage analytics: 
         1. Call the GetAnalytics Client Action. 
         2. Use the outputs (CellularSessionTime, WifiSessionTime, SdDataUsage) as needed in your app. 
   4. Update User Information 
      1. UpdateUserId: Call with the user’s ID to associate with the session.
      2. UpdateUserTag: Call with an array of tags (e.g., ["premium","beta"]) to update user segmentation.
   5. Get SDAuth 
      1. To retrieve authentication info for a specific URL: 
         1. Call GetSDAuth with the target URL as input. 
         2. Use the returned fields (SdState, Url, CarrierName, ClientIp) as needed. 
   6. Get Client IP
      1. Call GetClientIP to retrieve the device’s current IP address (Android only).