Please fill out the information below in as much detail as possible and contact your project manager should you have any questions.
Section I: API Access
To begin the integration, API access must be granted to Higher Logic. The API version must be 2.03 or higher for the integration to work. To obtain the information required for API access, please contact YourMembership.com support and ask them to provide you with the following:
| Public API Key (GUID) | |
| API Key (GUID) | |
| Sa Passcode |
Section II: Granting Member Status
Higher Logic will sync all records from YourMembership to the Online Community.
Please list the member type codes that exist in YourMembership. For each, please also include the API GUID of one user with that member type code.
MemberTypeCodeAccess to Site?Access to Open Forum/Show in Directory?User’s API GUID
| Example: Alum | Y/N | Y/N | Ex: 3D638C5F-CCE2-4638-A2C1-355FA7BBC917 |
| Example: STF | Y/N | Y/N | Ex: 3D638C5F-CCE2-4638-A2C1-355FA7000009 |
Higher Logic can categorize your Staff differently from your Members – this gives us capabilities like adding staff to a designated “staff” community, adding “staff” ribbons to their profile, and excluding them from the Most Active Members widget. To allow us to do this, please create a MemberTypeCode in YourMembership titled ‘Staff’, assign your team appropriately, and note this MemberTypeCode above.
Higher Logic also has the capability to limit records being synced to only records in certain security groups. If you would like to limit the sync in this way, please let your project manager know which of the above Member Types to add to our filter list. Users that are not in these security groups will not be able to access the site.
Section III: Expiration Date
By default, HL will use a record’s MembershipExpiry as the end date to their Community access.
Section IV: Events
Event information is synced from YourMembership to the Online Community once per day. A calendar of events will be created and available to Members in the Online Community.
Section V: Profile
Standard member contact information will be integrated from your AMS to create profiles including first name, last name, email address, phone number, company name/address, etc. By default, the Emp address fields are synced.
Section VI: SSO
Single Sign-On (SSO) allows members to move between your main organizational website and your HL site without having to log in to each site separately. From your HL site, a user will be directed to the login page on your YM site where they will enter their YM username/password. Upon signing in to YM, a domain cookie called YourMembershipSession is created with a session token. HL will validate the token through the YM web service. If the token is valid, the user will be logged in to HL.
Please provide YM credentials to use for testing. These can be for any user allowed to be synced to HL.
| Login Username | |
| Login Password | |
| API GUID of User |