How to map temporary entitlements for new orders from Limio to Zephr

A more advanced use case of the Limio / Zephr integration involves generating grants to specific entitlements for a temporary period. This allow users to access the product they have purchased immediately, for example a digital access, while more permanent entitlements are propagated via middleware or Zuora Billing.

This documentation outlines how you can leverage Zephr from the Limio app to generate these entitlements. 

Step 1: Ensure you have Zephr configured as a plugin in your Limio environment.

In your Limio environment go to Zephr and set up your Zephr Access Key, Zephr Secret Key, and Zephr Endpoint

Then, contact [e-mail] to request to add Zephr as a Limio's order processing plugin ("Request to add Zephr as an order plugin").

Step 2: Create your entitlements in Limio and map them to products in Zephr. 

In order for Zephr to know which entitlements and grants to give, Limio needs to provide the necessary information.

Limio does this from the Limio Entitlements that Limio sends as part of the order. Limio Entitlements are part of Limio Products, and one product can have multiple Entitlements. To create your Entitlements from the Limio Catalogue, head to Entitlements and you will see the options to add new or edit existing Entitlements. 

You will need to ensure the Entitlement Code matches the corresponding value in the external system, in this case, Zephr. In Zephr, this Entitlement Code is referred to as a Product Slug. 

Once your Entitlements have been created, you can attach them to a product by going to:

Products > Selecting a Product > Entitlements

Here you will see the list of Entitlements you created in the Entitlements tab, and will be able to select as many Entitlements as required for that product. 

Step 3: Leverage the Limio Zephr plugin to send the relevant information to Zephr and receive the grant

Once done, everything is setup and you can leverage the Limio Zephr plugin to send the necessary information to Zephr and receive back the grants for a given order. Place an order in Limio and go to the Process Event. 

In the example above, you will notice we are making two calls to Zephr APIs. 

The GET call checks there is a product in Zephr matching the Limio Entitlement Code:

"description":

string"E-Paper NCH Vollabo Digital Full Access ePaper Full access NCH titles"

 

"entitlement":{

3 items

"type":

string"bundle"

"entitlementTenant":

string"chmedia-uat"

"id":

string"8a3539a3-646b-4cc9-87f8-88fc4cefd7e3"

}

"id":

string"e-paper_nch_va"

"label":

string"E-Paper_NCH_VA"

The POST call sends the necessary information to Zephr, with the product_id being the Entitlement set in Limio:

"body":{

"startTime":

string"2024-08-14 13:20:31"

"endTime":

string"2024-08-16 13:20:31"

"entitlement_type":

string"bundle"

"entitlement_id":

string"8a3539a3-646b-4cc9-87f8-88fc4cefd7e3"

"product_id":

string"E-Paper_NCH_VA"

Upon receiving this grant, the end user is able to access their product.