Partner Functionality

Table of Contents

Partner Functionality

Functionality

Functionality

Core Partner functionality

  • The notion of a partner can be configured in the Dashboard using Referrer Profiles.

  • Partner mode is enabled when the user accesses the Dashboard site via a url containing referrer profile ID.

  • In partner mode the site retains the referrer ID in a cookie for a period of 30 days and the site configuration considers the following (even if the user leaves the site and comes back within 30 days):

    • List of domains allowed for registration - determines which domains will show up in pull-down for domain list for FIO Address Registration.

    • Allow designation of specific domain for the domain selection to default to - preselected_domain parameter

    • Allow custom domain registration - indicates weather custom domain registration is allowed.

    • Registration site referrercode - is used when registering free FIO Addresses on Registration site.

    • Registration site API token - is used when registering free FIO Addresses on Registration site.

    • TPID - this TPID is inserted info all FIO Chain transactions

  • When a user creates an account while in partner mode the referrer ID and the site configuration considers above indefinitely, even if cookies are deleted. Meaning every time a user logs in the site should reinsert referrer ID in a cookie which never expires and consider site configuration above indefinitely.

  • Conflict resolution

    • When a user has one referrer ID stored and accesses the site using another referrer ID, the last referrer ID should be active.

    • If a user creates an account with a specific referrer ID, that ID takes precedents over referrer ID passed in the url.

      • Example 1:

        • User A access the site with referrer ID R

        • User A creates an account

        • User A deletes cookies

        • User A access the landing page with referrer S

        • User logs in = referrer R is inserted in cookie

      • Example 2:

        • User A access the site with referrer ID R

        • User A access the landing page with referrer S

        • User A creates an account

        • Referrer S is inserted in cookie

      • Example 3:

        • User A access the site without referrer

        • User A creates an account

        • User A access the landing page with referrer R

        • User A logs in - no referrer is inserted in cookie

Contained Flow

Contained flow is different from Partner functionality, but can be used together. See https://fioprotocol.atlassian.net/wiki/spaces/DAO/pages/490307585

Landing Page

  • Partner landing page is build dynamically based on the following partner profile values:

    • List of domains allowed for registration

    • A default pre-selected domain

      • If only one domain - always default to the single domain

      • If more than one domain, allow for specification of which domain to be pre-selected

    • Allow custom domain registration

    • Logo

    • Landing Page text

    • Link back to partner site

  • Path

Referrer Profiles

  • Referrer profiles are configs loaded manually by developer to the Dashboard site to enable custom behavior. They contain the following settings:

    • ID - uniquely identifies profile

    • Partner name

    • List of domains allowed for registration

    • Default pre-selected domain

    • Allow custom domain registration - indicates if domain registrations are allowed

    • TPID to use on all FIO Chain transactions

    • Registration site referrercode

    • Registration site API token

    • Logo

    • Landing Page text

    • Redirect URL - optional. If not passed the contained flow terminates when the action is completed (user is redirected to same page they would have gone through if contain flow was not enabled) and full navigation and functionality is restored.

Inbound URL Structure

  • https://www.someurl.com/ref/{id}

  • https://www.someurl.com/?ref={id}

Where {id} is referrer profile ID

Referrer Profile Values