5 February 2015
User level: All
Required Adobe products (retail)
The DPS Entitlement Service is designed to allow users to test direct entitlement and restricted distribution in development apps. It is intended for demos, proofs of concept (POCs), and testing. It should not be used for production.
Restricted distribution is one form of entitlement in which users must be explicitly entitled to a folio to view it. For restricted distribution, you must set your folio as “retail” without an accompanying price in the respective marketplace.
This service is limited to 1000 HTTP requests per day from a viewer, based on App ID. Requests from the admin are not limited. If you would like to increase the request limit or remove it, contact Derek Lu, delu at adobe.
This service is composed of two pieces: an admin and XML services. The admin allows you to create users and groups and entitle folios to them. The XML services implement the three XML APIs that third party entitlement requires.
For more information about entitlement visit the direct entitlement section on Adobe Developer Connection.
If you would like to customize a storefront visit the configurator.
Your test app will use the Service URL and Integrator ID from the Entitlement Admin. These values are used in DPS App Builder in the Entitlement Details pane.
Using the Entitlement Admin you can create and update users. Users must have a username and password and contain an optional description field. A user can be entitled to one or more folios and can be assigned to one or more groups.
For example, suppose you are creating a Sales app and you have three users: Cheryl, Maria, and Clarence and you publish a retail folio specific to each user. In addition, you create multiple groups called North, South, and West. Each group is then entitled to a folio specific to their region such as “North Sales Policies”. In this example, Cheryl has been entitled to a folio named “Cheryl” and has been added to the “North” group. When she logs in she will see the folio named “Cheryl” and “North Sales Policies” since she is in the “North” group.
Using the Entitlement Admin you can create and update groups. Groups must have a name and contain an optional description field. You can entitle folios to a group and assign users to a group. Groups are not required although they are helpful for entitling groups of users.
The list of folios shows the folios available based on the DPS account used to login to this service. Only published and public folios are shown. Unpublished or Private folios are not available for entitlement. Both free and retail folios will be displayed, but entitlement only applies to retail folios, including folios intended for restricted distribution. Folio metadata cannot be edited from this tool.
When your folios are entitled, you are ready to test on the device.
Make sure that you publish restricted folios as Public and Retail. (Private folios do not appear in your app, and Free folios are available to all users.)
When using DPS App Builder to build your iOS app, make sure that you do the following:
For information on creating a DPS viewer, read the DPS App Builder overview.
Once you have your viewer running on your device, you can test 3rd party entitlement by tapping the sign in button and signing in. Once you have successfully logged in, you should see the retail folios entitled for the user.
By using the DPS Entitlement Service you can test 3rd party entitlement and restricted distribution.
If you would like to download and install this entitlement service on your own server go to How to install the DPS Entitlement Server.
Comments are currently closed as we migrate to a new commenting system. In the interim, please provide any feedback using our feedback form. Thank you for your patience.