Nami Documentation
Sign In

Legacy Paywalls

Deprecated

The functionality described in this document was available in the 1.x and 2.x versions of the Nami SDK and has been deprecated in 3.x

Contact us to learn how to migrate to the 3.x no-code paywalls

In this article, learn how to link a custom Paywall implementation to Nami, so you manage it from the cloud.

This approach is recommended if you have an existing paywall implementation that you have coded yourself.

If you are building a new app or would like to add a paywall without requiring code, consider using the Paywall Creator.

Link a Custom Paywall to Nami

Developer Note

Linking Nami to your custom paywall requires your developer to connect your paywall implementation to the Nami SDK so it can be managed from the Nami Control Center.

  1. Navigate to Nami Control Center > Paywalls

  2. Click the "+ Add Paywall" button

  1. Choose "Code your own paywall design"

Then click Get Started to configure the new paywall

Configure a Linked Paywall

  1. Name the paywall

The paywall name is used throughout the Nami Control Center to identify your paywall and is not visible to your app's end users. Click the Pencil icon ✏️ to edit Paywall Content. Enter a paywall name in the Overview > Name field then click "Update" to save your changes.

  1. Navigate to the Images section. Upload background artwork, then click "Update" to save your changes.

This is used to visually identify your paywall throughout the Nami Control Center, including on the Paywall tile view.

Artwork Specifications

Format: Compressed JPEG

Dimensions: Phone 2,000 x 1,000, Tablet: 2,000 x 2,000

  1. Navigate to the Content section. Input a title and body, then click "Update" to save your changes.

The title text is the key headline and the body is supporting text.

  1. Click the Tag icon 🏷 to navigate to the Products tab.

Adding In-App Purchase Products to a Paywall

In order to add Product SKUs to a Paywall, you will need to complete the following steps.

  1. Add an App Platform.

  2. Add Product SKUs.

  3. Associate Product SKUs with an Entitlement.

Until you complete these steps, you may not see any in-app purchase products that can be added to your paywall.

Follow the links to each of the guides to complete these steps.

Select an App Platform from the dropdown. The Disabled Products list will populate with the Product SKUs for that platform. Drag products from Disabled Products to Enabled Products to display on your paywall. Select Product SKUs for each App Platform that this paywall is going to run on.

On each App Platform your app runs on, your users will only see the product SKUs for that specific platform.

Choose up to three in-app purchase products to sell through this paywall.

Click "Update" to save your changes

  1. Navigate to Legal tab. Setup paywall legalese. Click "Update" to save your changes.

Paywalls can display Purchase Terms and link to your Terms of Use and Privacy Policy.

Purchase Terms are configured per paywall.

Terms of Use and Privacy Policy are configured per-app, navigate to App Settings to populate.

Legal & App Review

Apple App Store apps must somewhere surface a Privacy Policy and Terms of Use. This does not have to be done within the paywall, but that is a best practice.

If the Privacy Policy and Terms of Use fields in App Settings are left blank, no legal links will be displayed within the paywall.

Developer Details

Connecting the Linked Paywall data defined in the Control Center to your mobile app requires a little development work. Please consult this guide for details.

Custom Data in Linked Paywalls

Linked Paywalls are used in the Nami platform to add cloud-based controls to a paywall you have already built in your app.

In many cases, you may have elements of your Linked Paywall that you would like to control from the cloud, but are not part of our standard set of controls that we have exposed in our Control Center. We've built a general system to help enable these use cases by allowing you to define any set of Key-Value pairs and pass them to the SDK.

To see how to use custom data in the SDK, read this guide.

Let's take a look at how to use them.

  1. In the Control Center, go to the Paywalls screen and select a Linked Paywall from the available list.

Key-Value pairs are only available for Linked Paywalls and not paywalls made with the Paywall Creator.

  1. Click on Content and then the Add Key-Value button.

  1. Enter a Key and Value and click Add.

Keys and Values are stored as a JSON object

Under the hood these are stored as JSON. You will get an "Invalid format for Value" error if the data you enter cannot be converted to JSON.

Keys may not have spaces in the name, and we recommend not using any special characters and limiting to standard ASCII characters.

Values supported:

  • Integer numbers - 1234, no commas or other symbols

  • Strings - must be in double quotes e.g. "my string for the value"

  • Arrays - ["one", 2, "three"]

  • JSON - must use double quotes {"key": "value"}

Each Key must be Unique

Adding a new Key-Value where the Key matches one that already exists will update that already existing Key with the new Value.

  1. When back on the Paywall Detail screen, do not forget to click the Save button to commit your changes.

  1. To remove a Key-Value, click the 'x' button.

Last updated