MemberSpace API
  • Welcome
  • Getting Started
    • Install Code
      • Multi-subdomain site
    • Using query parameters
  • Javascript API
    • Signature
      • Events
        • MemberSpace.ready
        • MemberSpace.member.info
        • MemberSpace.member.logout
        • MemberSpace.member.registration
        • MemberSpace.conversion
      • Functions
        • MemberSpace.getMemberInfo
        • MemberSpace.getMemberMetadata
        • MemberSpace.updateMemberMetadata
        • MemberSpace.clearMemberMetadata
      • Flags
        • MemberSpace.ready
      • Structures
        • MemberInfo
    • Guides
      • Getting Member Information - SSR
      • Getting Member Information - SPA
    • Migration Guide
  • Protecting content
    • Showing/Hiding Elements
  • Embedding
    • Member Information
      • Embedding Member Info
      • Prefilling Forms
      • Available Data Types
  • Links
    • Help Center
    • Admin
    • Sign Up
Powered by GitBook
On this page

Was this helpful?

  1. Getting Started

Using query parameters

The widget is capable of opening a modal with a specific screen on startup when instructed using a query parameter

You can use the msopen query parameter on any page the widget is installed on. Path sections starting with : are placeholders, values need to be substituted in in their place. Placeholders, ending with ? are optional and can be omitted I.e., given a domain of `https://example.com`, a content id of `abc123` and a path of /content/:contentId/:viewingPreference? the following URLs can be generated: - https://example.com?msopen=/content/abc123 - https://example.com?msopen=/content/abc123/popup

Recognized paths

Target
path
If logged in
If not logged in

Log in

/member/sign_in

Will take to the member menu or if not enabled, the account screen

Show login screen

Log out

/member/sign_out

Log user out

-

Register user

/member/sign_up/:planPublicId?

Will take to the member menu or if not enabled, the account screen. Will take the

Will register the user and offer to sign up to a plan. - If no plan specified, the after registration action will be executed.

Sign user up to a plan

/member/plans/:planPublicId?

Will offer to sign up to a plan. - If no plan specified, the after registration action will be executed. - If user is already on specified plan, will navigate browser to the content URL of the plan.

Register user first

All plans sign up

/member/plans/all

Will offer to sign up to any public plan

Register user first

Account

/member/account

Display account screen

Log user in first

Account edit

/member/account/edit

Display account edit screen

Log user in first

Email change

/member/account/email_change

Display email change screen

Log user in first

Password change

/member/account/password_change

Display password change screen

Log user in first

Invoices

/member/invoices

Display invoice list screen

Log user in first

Payment method change

/member/payment_method/update

Display payment method change screen

Log user in first

Membership list

/member/memberships

Display membership list screen

Log user in first

Protected content

/content/:contentId/:viewingPreference?

Display protected content. viewingPreference can be download (default), or popup. Some content types only support a specific `viewingPreference`

Log user in first

PreviousMulti-subdomain siteNextSignature

Last updated 9 months ago

Was this helpful?