AI Paywall

You can now integrate Sub(x) with Zephr using the AI Paywall extension.

1. Navigate to Settings > Extensions.
2. Select AI Paywall. If you cannot see the option in your list of Extensions, contact the Support team.
3. Select AI connection settings.
4. Enter the details to connect to Sub(x).

   Field	Your Action
   Base URL	Enter the primary endpoint for the Sub(x) platform. This is the URL where the API requests will be sent.
   Brand ID	Provide the unique identifier for your brand within the Sub(x) platform. This ensures that the connection is established for the correct brand.
   AI Basic Auth Username	Input the username associated with the AI Basic Authentication for secure access to the platform.
   AI Basic Auth Password	Enter the corresponding password for the AI Basic Authentication. Ensure this is kept secure.
   HTTP Request Timeout (in milliseconds)	Specify the maximum time the system should wait for a response from the Sub(x) platform before timing out. This helps manage delays and ensures the connection remains responsive.

   

5. Select GetDecisionAPI request mapping settings.
6. Configure the data sent to the AI Paywall, including user ID, session ID, user agent, referer, and country code for personalized decision-making.

   Field	Your Action
   Send the Zephr UserID to AI Paywall	Enable this option to send the Zephr UserID to the AI Paywall. This should only be activated if you use Zephr's Identity module to uniquely identify users.
   Send the Zephr Session ID to Paywall	Enable this setting to transmit the Zephr Session ID to the AI Paywall, allowing the system to associate requests with specific user sessions.
   Send user agent from incoming decision engine request	Enable this option to pass the user agent string from the incoming decision engine request to the AI Paywall. The user agent provides details about the user’s browser and device.
   Send referer from incoming decision engine request	Enable this setting to forward the referer (the URL of the previous page) from the incoming decision engine request to the AI Paywall. This helps track the user's navigation path.
   Send country code from GeoIP	Enable this option to send the user's country code, derived from GeoIP data, to the AI Paywall. This allows the AI Paywall to tailor decisions based on the user's geographical location.
   List properties to send to Sub(x) from customData (comma-delimited, applies to HTML features)	Specify which customData properties to send to Sub(x) for HTML features separated by commas.
   List properties to send to AI Paywall from customInputs (comma-delimited, applies to SDK features)	Define the customInputs properties to be sent to the AI Paywall for SDK features separated by commas.
   List properties to send to AI Paywall from JWT (comma-delimited)	List properties to send to AI Paywall from JWT (comma-delimited)
   Define a list of user states (comma-delimited)	Specify user states to be included in the decision-making process separated by commas.
   Read queryParams from objectStore key (allows Custom Script nodes in the rule to add JSON string data to the Get Decision request)	Enter the objectStore key name to retrieve query parameters, enabling Custom Script nodes to add JSON string data to the Get Decision request.

7. Click the GetDecisionAPI response routing settings option to configure how the GetDecisionAPI response is routed.
8. Click the GetDecisionAPI response caching settings option to cache the GetDecisionAPI response. You can choose to retain it for the session duration or specify a time range and number of days.
9. Select the sites in which you want to enable this plugin.
10. Click Save.

Once the extension is enabled, navigate to Products > Features and select any existing article. The AI Paywall node will be displayed.

For more information, see AI Paywall Node.