API - Technical References
What is it for?
Section titled “What is it for?”The technical reference is a UTF-8 character string that you can provide to uniquely identify ProAbono resources in your API calls.
We recommend customizing these technical references so that your application can easily identify the targeted resources when communicating with ProAbono.
Format
Section titled “Format”- Maximum 50 characters.
- Excluded characters: < > ; “ = ? &
Technical References
Section titled “Technical References”Segment Reference (ReferenceSegment)
Section titled “Segment Reference (ReferenceSegment)”Identifies a Segment.
This reference is unique per Business, modifiable only through API.
Usage:
- Customer creation
- Widget installation
Consequence of modification:
- May break your customer enrollment processes.
- Consult support before making any modifications.
Customer Reference (ReferenceCustomer)
Section titled “Customer Reference (ReferenceCustomer)”Identifies a Customer.
This reference is unique per Segment, modifiable through API or from the BackOffice.
Usage:
- Subscription creation
- Widget installation
- Various customer operations
- Retrieve your customer’s rights and usages at any time.
Consequence of modification:
- May block your application’s access to your customer
- May grant access to another user’s data.
Pricing Table Reference (ReferencePricingTable)
Section titled “Pricing Table Reference (ReferencePricingTable)”Identifies a Pricing Table
This reference is unique per Segment, modifiable through API or from the BackOffice.
Usage:
- Rebuilding your page of offer presentation.
Consequence of modification:
- May break subscription processes
Offer Reference (ReferenceOffer)
Section titled “Offer Reference (ReferenceOffer)”Identifies an Offer
This reference is unique per Segment, modifiable through API or from the BackOffice.
Usage:
- Starting a subscription enrollment process
- Creating a custom subscription.
Consequence of modification:
- May break subscription processes
Feature Reference (ReferenceFeature)
Section titled “Feature Reference (ReferenceFeature)”Identifies a Feature
This reference is unique per Business, modifiable through API or from the BackOffice.
Usage:
- Allows you to check at any time who has what rights in your application
- Customizing subscriptions at startup
Consequence of modification:
- Restricts access to one of your features for all of your users.
Discount Reference (ReferenceDiscount)
Section titled “Discount Reference (ReferenceDiscount)”Identifies a Discount
This reference is unique per Segment, modifiable through API or from the BackOffice.
Usage:
- Allows you to manage cross-segment discounts
Consequence of modification:
- No longer applies the discount during an associated process (subscription / subscription modification or offer creation)