Zephr User Guide

Example Customer Pages

5 views 0

In this example, we show the Preference Centre pages that the customer can use to manage their product shares. We also provide the API calls that are used so that you can create your own management pages if required.

When the customer logs into their Preference Centre, they can manage the products that they have shared as follows:

  1. Select the Subscription Information link
  2. Select the Manage shared members link

A summary of the products that they have shared is displayed, as illustrated below:

Shared Members

The summary can be displayed using the following GET command:

GET /zephr/public/products/v1/shares

For further information on the schema, and an example header and body content, refer to the API documentation.

In our example page, we have used a Remove member option to allow the customer to remove the shared product from a seat. This is achieved using the following API call, where the {sharing_id} variable is the identifier of the product share to delete:

DELETE /zephr/public/products/v1/shares/{sharing_id}

For further information on this command and an example URI, refer to the API documentation.

If you want to allow the customer to send invitations from the Preference Centre, or equivalent, page, you can use the following API calls:

  • To send an email, which has been created as described in the Create a Custom Email Template topic, use the following POST command:

    POST /zephr/public/products/v1/shares/invitations/emails

  • To use a token, for example for use in WhatsApp, use the following POST command:

    POST /zephr/public/products/v1/shares/invitations/tokens

    You can also generate a token and include it in a shareable link, or other format used in your UI. The customer can share the link with an invitee manually, for example using WhatsApp.

  • Notes:

    1. The specified product must be shareable and the customer must have active grant for that product
    2. Each time the customer sends an invitation, or generates an invitation token, the number of available shares is reduced by one
    3. The customer cannot send further invitations when the number of available seats reaches zero
    4. The customer cannot send an email invitation to the same email address more than once

    For further information on these commands, refer to the API documentation.