Login and Read User Information
This is the most basic SSO API functionality which allows access to the X-CD system through logging in from the membership system. X-CD will capture the active user’s information (name, email, etc.) as they are being transferred into X-CD. X-CD will either create an account for that user or assign a previously existing user account for that user.
Membership Type Information
Additional API methods may be needed to read a user’s membership status. Information about an end user’s membership/non-membership status to X-CD may allow X-CD to perform one or more of the following actions:
Only display a single registration type on the X-CD defined registration form (this presets the registration type for the end user which cannot be edited by the end user)
Put the end user in one of the defined groups in X-CD
The groups then control registration type visibility (eg. member rates)
3. Event Registration Information
Additional API methods may be needed to read a user’s event registration details. Registration categories/selections of a user may define what sessions they have access to for the following purposes:
Session details access with virtual platform or mobile app
Session access for continuing education purposes
4. Co-Author Lookup
When users are submitting conference speaker proposals - some authors may want to find other members who are already in your membership database. Additional API methods may be needed to search all users in your membership system.
5. New User Creation (Co-Author Creation)
When users are submitting a conference speaker proposal - some authors may add a new contact as a co-author. This new contact can be written back to your membership system with an additional API method.
6. Nightly Synchronization of Contact Data
After users are created inside X-CD it is possible they will sometime thereafter update their information directly inside your membership system. When this happens X-CD must read changes and update the X-CD contact record. This is most easily done by a nightly synchronization of “users who have changed profile data recently”. To accomplish this another API method is needed where we can search for contacts who have changed “since yesterday” and update the related user contact information within X-CD.
Your membership system must have an API that is available to 3rd party developers (X-CD)
The API must include single sign on ability
Ensure your membership system offers a Single Sign On API
Ask your membership system for:
- API access / keys to provide to a 3rd party platform (X-CD) who wants to create a Single Sign On application
- API documentation related to:
-- single sign on
-- reading user account information
-- creating a user
-- finding users who have changed their profile data from a certain date
Provide X-CD with the API credentials & the documentation