Working with benefits
Intro
Use case description of how to use benefits via the Magicline Open API.
Relevant Endpoints
- GET customer's benefits
- GET customer's benefits by card number
- POST customer's benefit usage
- POST save weighing results
Benefits in the Magicline World
Benefits are a common element in the Magicline software that enable studio operators to grant their customers access
to certain services within their clubs (i.e. Sauna or Peronal Training). In the context of the Magicline integration,
we offer partners the option to integrate their partner specific benefits in the Magicline upon activation.
This allows operators to work with partner benefits to configure which customers are eligible and offers a
diverse set of configuration to drive upsells based on partner benefits.
Partner benefits are configurable in the partner integration detail view
Validating customer benefits
To allow easy handling of your benefits via the Open API we offer a set of generic endpoints
that inform you about a customers eligibility regarding your benefits.
You can choose between:
-
GET customer's benefits
- here you can pass the customerId to gather which of your benefits (identified by their
BENEFIT_KEY) a customer can use -
GET customer's benefits by card number
- here you can pass a customers cardNumber to gather which of your benefits (identified by their
BENEFIT_KEY) a customer can use
Posting benefit usage
Once you have validated a customers eligibility to use your benefit,
it is crucially important to post the usage of your benefit back to the Magicline using the 'Post customer's benefit usage endpoint'.
This ensures that the Magicline remains the single source of truth regarding contingents of your benefits
that can be configured in the Magicline and that upsell mechanisms work as intended.
Exception: if you are a body measurement partner and post weighing results back to the Magicline.
You can opt to choose between the 'Post customer's benefit usage endpoint' or you can simply pass along your benefit key
when posting the measurement results via the 'Save weighing results endpoint'.
Cross-facility benefit usage for partner benefits
To handle situations where your partner integration may be activated in multiple studios of the same tenant,
the Open API has a built-in cross facility usage function. This functionality enables customers to use partner benefits in related studios
of the same tenant where the same partner integration is activated.
In this use case, we assume two studios of the same tenant (Studio A and Studio B ) and a customer with their data set in Studio A.
Both Studios have the same partner integration activated which has the cross facility partner benefit.
Customer A has an additional module attached to her contract which allows her to use the benefit 5 times per month.
If the customer A tries to use this benefit in Studio B,
Magicline will check the inclusive contingent in Studio A and if the customer uses the benefit in Studio B,
will reduce the inclusive contingent in Studio A.