Shopping Portal
Partner OAuth Integration Guide
5 min
this guide outlines how user authentication and cash back tracking will work between your system and the wildfire hosted shopping portal it’s designed to help you understand the authentication user flow and align on what’s needed to begin integration overview our shared goal is to deliver a seamless, white labeled shopping experience where users authenticate through your login system (oauth based) users shop and activate cash back offers on the wildfire hosted shopping portal we track purchases and return user level attribution using your identifiers summary of user flow the following user flow and sequence diagram describe a typical implementation of oauth based authentication and purchase tracking we recognize that oauth implementations vary by partner — including grant types, token exchange steps, user info formats, and refresh mechanisms we're flexible and will integrate with the specific oauth flow your system supports our goal is to accommodate your existing architecture while ensuring secure and consistent user identification for cash back tracking authentication and tracking flow user lands on your white labeled shopping website (hosted by wildfire) user clicks “log in ” user is redirected to your oauth login endpoint , with a return uri to the wildfire hosted shopping portal user authenticates on your login page your system returns an authorization code or token , depending on your oauth implementation wildfire uses the token to retrieve a persistent user identifier (pud) — typically from the sub field, but configurable based on your token format we recommend using a uuid as the pud, though the choice is up to your system the pud is stored in the wildfire system and tied to the user session when the user activates a cash back offer , the pud is included in the event payload when a merchant confirms a purchase , the purchase is associated with the pud wildfire makes commission event data available via the commission api , which your system can map individual commissions using the persistent user identifier (pud) to credit the appropriate user if your system registers for callbacks, wildfire will also send a best effort notification when a commission is imported or when its status changes note that callbacks are fire and forget and not retried — the commission api should be treated as the system of record note for users already authenticated in your ecosystem and sent to the shopping portal, you may begin at step 5 by including the authorization code or token in the redirect example flow diagram what we need from you to integrate with your oauth system, we’ll need oauth authorization and token endpoint urls client id (and client secret , if applicable) list of required scopes the token format you use (e g , jwt or opaque), and validation method the user identifier field to use as the pud confirmation of redirect uri allowlisting any additional requirements related to session handling or error formatting if you have a developer portal with oauth documentation, providing access is a great way to accelerate the integration process