Skip to content

Getting started with Arc XP Subscriptions iOS Module

Last updatedView as Markdown

The Arc XP Subscriptions iOS module includes identity and paywall features, to create and manage user accounts, and to determine which content your users should be allowed to view or not.

To use the Arc XP Subscriptions module, complete the following steps.

Prerequisites

Before you begin adding Arc XP Subscriptions iOS module to your project, there are a few things to take care of.

Get your Arc XP configuration details from your Arc XP contact. These include:

  1. Back-end base URL
  2. Organization
  3. Site
  4. Environment

These details are required for configuring the Subscriptions module in your project. Without the correct configuration details, the framework will not work.

Test your base URL to make sure your backend is responding properly. This can be done in any web browser. In your web browser, enter the following URL:

{your base url}/identity/public/v1/config

Example:

https://arcsales-arcsales-sandbox.api.cdn.arcpublishing.com/identity/public/v1/config

If the preceding URL does not work for you, there may be a problem with how your Arc XP backend was set up, and you should reach out to your Arc XP contact to create a ticket on diagnosing the issue.

After you’ve retrieved your configuration details and verified that the backend is working correctly, you can start setting up your project with the required dependencies.

Dependencies

With consideration for the features you want to implement, you may omit any of these dependencies, but know that you may need to sort these dependencies out in the future if you decide to use the module features which rely on them.

First, make sure your project has been set up to work with Swift Package Manager. For more information, visit the Swift Package Manager documentation.

Include the GoogleSignIn-iOS package dependency in your project. For instructions on how to add package dependencies to projects, visit Adding package dependencies to your app.

Installation & Setup steps

Follow the installation and setup steps outlined in Getting Started with Arc XP iOS SDK document for getting started with the Arc XP iOS SDK.

Additional Documentation