Read a trader's record over the API, and link straight into the portal
Pull a trader's full loyalty record over the API by email or ID, and add deep links that open a part of the portal from inside an embedded frame.
01 ·Read a trader's record over the API
A read endpoint joins the API that returns a single trader's record, looked up by email or by their ID. The response carries their coins and XP, the coins and XP they have earned that day, the roles they hold and their highest role, their name and language, and the values in a broker's custom fields. The endpoint is governed by its own permission a broker grants on an API key.
A broker running loyalty data through their own stack wants to read a trader's standing from the source rather than keep a copy in step. An endpoint that hands back coins, XP, roles, and custom fields lets a broker pull a trader's record into their CRM or reporting tools on demand.
02 ·Link straight into a part of the portal
A broker who runs the community inside an embedded frame on their own site can now add deep links that open a chosen part of the portal directly. A new iFrame Deep Links area in the integration settings lists a destination and its link for the store, the leaderboard, quests, milestones, badges, socials, referral, profile, and each channel. A link opens its destination in place, so a trader lands on the page rather than reloading the frame.
A broker embedding the community on their own site wants a button on that site to drop a trader on the right page, the store or a leaderboard, not the front door. Deep links that open in place let a broker wire their own navigation straight to the part of the portal a trader needs.
Forum channel permissions gained a post-message toggle, so a broker can set which roles write in a forum channel while roles that can already post keep that access.
9 Jun