Widget - API : Initialization

Widget Behavior

The widget can be initialized in two ways, depending on whether you are using a Single-Page Application or a standard page with basic JavaScript.
Both installations are detailed directly in the back office.

In both cases, initialization (or startup) requires parameters in the form of a JavaScript object.

Example:

{
  business_id: 1,
  segment_ref: "seg-eur",
  customer_ref: "cust-42",
  customer_name: "John Doe",
  customer_email: "john@doe.com",
  customer_lang: "en",
}

Widget Behavior

• If the user does not exist, they will be added to your ProAbono Business in the specified Segment.
• If the user already exists, then their name (customer_name:) and language (customer_lang) will be updated, if applicable.

Note: the customer’s email will never be updated by the widget, as the customer may choose a different email to receive their invoices in the customer portal.

Parameters

Parameter	Description	Required?
business_id	The unique identifier of your ProAbono Business. You can find it in the integration section of your ProAbono back office.	Yes
segment_ref	The reference of the relevant Segment. You can find it in the integration section of your ProAbono back office.	Yes
customer_ref	The reference of the identified user. This technical reference is unique and is intended to be the same technical identifier as in your information system.	Yes
customer_name	The name of the identified user. The customer’s name is for internal use only. It is not the name used in the customer’s billing address.	No
customer_email	The email address of the identified user. This email address is used to send invoices to the customer.It may be different from the user’s login email (in fact, the user can change it autonomously from the customer portal).	No
customer_lang	The language of the identified user. This language will be used for hosted pages (presentation of offers, subscription workflow, customer portal, etc.).	No
offer_ref	The reference of the selected offer. If you specify an offer reference, the behavior of the widget will be slightly different. It will open: - Directly to the subscription process for this specific offer if the user is not yet subscribed - To the customer portal if the user is already a subscriber	No
visible	By default, the widget is visible. You can use the “visible” parameter to create your own button or workflows (see more information).	No